X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=fe6a06b61855524c4eb4b930cb90fdea73f260c4;hb=8fed8d1bacbbcbf606a94497c5b58f49068bd6a3;hp=eef8714bae7fb7390fac62943053870ca90643a7;hpb=28667ee7a7801222dfba92e4f47151b4d9e4b006;p=github%2Fwallabag%2Fwallabag.git
diff --git a/README.md b/README.md
old mode 100755
new mode 100644
index eef8714b..73c34ae0
--- a/README.md
+++ b/README.md
@@ -1,32 +1,27 @@
-# 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.
-To get news from poche, [follow us on twitter](http://twitter.com/getpoche).
+More informations on our website: [wallabag.org](https://wallabag.org)
-[If you want to flattr poche, it's here.](https://flattr.com/thing/1225780/nicosombpoche-on-GitHub)
+# Install wallabag
-## Usage
-You can easily add a "poched" page with the bookmarklet.
+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:
-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
+ ./install.sh
+ 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.