Changed the default command when we launch make

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

diff --git a/README.md b/README.md
index 38866f7af91a91cd25cc5da81c877fb96a458f24..436272c03082e1fec3b317953515d58781a5de9b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,28 @@
-# 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)
 
-More informations on our website: [wallabag.org](http://wallabag.org)
+# 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.
 
-## License
-Copyright © 2013-2014 Nicolas Lœuillet <nicolas@loeuillet.org>
+More information on our website: [wallabag.org](https://wallabag.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
+    ./install.sh
+    php bin/console server:run --env=prod
+```
+
+# License
+Copyright © 2013-2016 Nicolas Lœuillet <nicolas@loeuillet.org>
 This work is free. You can redistribute it and/or modify it under the
 terms of the MIT License. See the COPYING file for more details.