Merge pull request #4438 from wallabag/dependabot/composer/scheb/two-factor-bundle...

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

diff --git a/README.md b/README.md
index 6f950ad0bd2c1e9d911aa6dedf90a4a572cef6af..e00c7ea061c26a68dcd6f9b3dd49fe1073e8e7ee 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,10 +1,35 @@
-# what is wallabag ?
-wallabag is a self hostable application allowing you to not miss any content anymore. Click, save, read it when you can. It extracts content so that you can read it when you have time.
+[![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 test wallabag, a demo website is online : [demo.wallabag.org](http://demo.wallabag.org) (login poche, password poche).
+# 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.
 
-## License
-Copyright © 2010-2013 Nicolas Lœuillet <nicolas@loeuillet.org>
+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).
+
+![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](https://doc.wallabag.org/en/admin/installation/requirements.html).
+
+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-current 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.
+terms of the MIT License. See the COPYING file for more details.