X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=c948828843bc043589ba6217dcb6f437ee8c470b;hb=a40b2b7ee4f5aec502c4ddc755ed7d15f9b7a756;hp=2e14888cd4ffd2b1cbe2b979b1743203fac8eb0d;hpb=28cbf46cf5bae81b6fe25c89237d0a005281086a;p=github%2Fwallabag%2Fwallabag.git
diff --git a/README.md b/README.md
old mode 100755
new mode 100644
index 2e14888c..c9488288
--- a/README.md
+++ b/README.md
@@ -1,28 +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)
-To get news from poche, [follow us on twitter](http://twitter.com/getpoche).
+# 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.
-## Usage
-You can easily add a "poched" page with the bookmarklet.
+More information on our website: [wallabag.org](https://wallabag.org).
-You can :
-* read a page in a comfortable reading view
-* archive a link
-* put a link in favorite
-* delete a link
+![wallabag logo](https://raw.githubusercontent.com/wallabag/logo/master/_default/typo-horizontal/png/sm/logo-typo-horizontal-black-no-bg-no-border-sm.png)
-## 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
-
+# Install wallabag
+Please read [the documentation to see the wallabag requirements](http://doc.wallabag.org/en/master/user/installation.html#requirements).
+
+Then you can install wallabag by executing the following commands:
+
+```
+git clone https://github.com/wallabag/wallabag.git
+cd wallabag && make install
+make run
```
-## License
-Copyright © 2010-2013 Nicolas LÅuillet
+# License
+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.