X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=048315c04b6620e8b49e7d1fe39249c3572d7c35;hb=9d127b3b9365c73bc393bc303545f24c159cee31;hp=a03db980261e48e82c1c689145b7cbf3b406be56;hpb=9232dd8b2a599397aff61d5ffadd1b5f07d00d35;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md old mode 100755 new mode 100644 index a03db980..048315c0 --- a/README.md +++ b/README.md @@ -1,34 +1,28 @@ -# poche -Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source. +[![Build Status](https://api.travis-ci.org/wallabag/wallabag.svg?branch=master)](https://travis-ci.org/wallabag/wallabag) +[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/wallabag/wallabag/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/wallabag/wallabag/?branch=master) +[![Gitter](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/wallabag/wallabag) -![poche](http://cdetc.fr/poche/img/logo.png) +# What is wallabag? +wallabag is a self hostable application allowing you to not miss any content anymore. +Click, save and read it when you can. It extracts content so that you can read it when you have time. -The website of poche is [inthepoche.com](http://inthepoche.com). +More informations on our website: [wallabag.org](https://wallabag.org) -To get news from poche, [follow us on twitter](http://twitter.com/getpoche). +# Install wallabag -[If you want to flattr poche, it's here.](https://flattr.com/thing/1225780/nicosombpoche-on-GitHub) +If you don't have it yet, please [install composer](https://getcomposer.org/download/) or be sure to use Composer 1.2 (`composer selfupdate` can help you about that). Read [our documentation](http://doc.wallabag.org) to have more information about installation. +Then you can install wallabag by executing the following commands: -## Usage -You can easily add a "poched" page with the bookmarklet. - -You can : -* read a page in a comfortable reading view -* archive a link -* put a link in favorite -* delete a link - -## Security -You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition : -```apache - - Order allow,deny - Deny from all - +``` + git clone https://github.com/wallabag/wallabag.git + cd wallabag + git checkout 2.1.1 + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console wallabag:install --env=prod + php bin/console server:run --env=prod ``` ## License -Copyright © 2010-2013 Nicolas Lœuillet +Copyright © 2013-2016 Nicolas Lœuillet This work is free. You can redistribute it and/or modify it under the -terms of the Do What The Fuck You Want To Public License, Version 2, -as published by Sam Hocevar. See the COPYING file for more details. \ No newline at end of file +terms of the MIT License. See the COPYING file for more details.