Fix documentation wording for matches/notmatches tagging rules

[github/wallabag/wallabag.git] / README.md

diff --git a/README.md b/README.md
old mode 100755 (executable)
new mode 100644 (file)
index e0712ad..15c4ecb
--- a/README.md
+++ b/README.md
@@ -1,13 +1,35 @@
-# poche
+[![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)
 
-Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source.
+# What is wallabag?
+wallabag is a self-hostable PHP 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
+More information on our website: [wallabag.org](https://wallabag.org).
 
-...
+If you do not have your own server, consider [the wallabag.it hosting solution](https://wallabag.it).
 
-## License
-Copyright © 2010-2013 Nicolas Lœuillet <nicolas@loeuillet.org>
+![wallabag logo](https://raw.githubusercontent.com/wallabag/logo/master/_default/typo-horizontal/png/sm/logo-typo-horizontal-black-no-bg-no-border-sm.png)
+
+# 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 
+```
+
+Now, [configure a virtual host](https://doc.wallabag.org/en/admin/installation/virtualhosts.html) to use your wallabag. 
+
+# Run on YunoHost
+[![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wallabag2)
+
+Wallabag app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/wallabag2_ynh)
+
+# License
+Copyright © 2013-2018 Nicolas Lœuillet <nicolas@loeuillet.org>
 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.