manage assets through npm

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

diff --git a/README.md b/README.md
index 1e33940a8de9fa70a9e4a31bfdfc8cbe90022951..2a7b54bf78b89aa793ecf652d2044e1e26cf204f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,22 +1,28 @@
-# What is wallabag ?
+[![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=v2)
+[![Gitter](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/wallabag/wallabag)
+
+# 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.
+Click, save and read it when you can. It extracts content so that you can read it when you have time.
 
-More informations on our website: [wallabag.org](http://wallabag.org)
+More informations on our website: [wallabag.org](https://wallabag.org)
 
-# Want to test the v2 ?
+# Install wallabag
 
-Keep in mind it's an **instable** branch, everything can be broken :)
+If you don't have it yet, please [install composer](https://getcomposer.org/download/).
+Then you can install wallabag by executing the following commands:
 
 ```
-git clone https://github.com/wallabag/wallabag.git -b v2
-cd wallabag
-composer install
-php app/console wallabag:install
-php app/console server:run
+    git clone https://github.com/wallabag/wallabag.git
+    cd wallabag
+    git checkout 2.0.5
+    SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
+    php bin/console wallabag:install --env=prod
+    php bin/console server:run --env=prod
 ```
 
 ## License
-Copyright © 2013-2015 Nicolas Lœuillet <nicolas@loeuillet.org>
+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.