]> git.immae.eu Git - github/wallabag/wallabag.git/blobdiff - README.md
Update README.md with the environment parameters
[github/wallabag/wallabag.git] / README.md
index 13e730c9679aa2b3e07673fda9a758022527000c..39d497d8f7a7e65c25ebf0b5b5a2f753f93e11f9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,22 +1,25 @@
-# What is wallabag ?
+[![Build Status](https://travis-ci.org/wallabag/wallabag.svg?branch=v2)](https://travis-ci.org/wallabag/wallabag)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/wallabag/wallabag/badges/quality-score.png?b=v2)](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 ?
+# Want to test the v2?
+Keep in mind it's an **unstable** branch, everything can be broken :)
 
-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 refactor
-cd wallabag
-composer install
-php app/console wallabag:install
-php app/console server:run
+SYMFONY_ENV=prod composer create-project wallabag/wallabag wallabag "2.0.*alpha" --no-dev
+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.