Merge pull request #2584 from blankoworld/master

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

diff --git a/README.md b/README.md
index 34f60b9084f855301b10392b0534721099392276..c948828843bc043589ba6217dcb6f437ee8c470b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,26 +1,27 @@
-[![Build Status](https://travis-ci.org/wallabag/wallabag.svg?branch=v2)](https://travis-ci.org/wallabag/wallabag)
-[![Code Coverage](https://scrutinizer-ci.com/g/wallabag/wallabag/badges/coverage.png?b=v2)](https://scrutinizer-ci.com/g/wallabag/wallabag/?branch=v2)
-[![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)
+[![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)
 
-# What is 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 information on our website: [wallabag.org](https://wallabag.org).
 
-# Want to test the v2 ?
+![wallabag logo](https://raw.githubusercontent.com/wallabag/logo/master/_default/typo-horizontal/png/sm/logo-typo-horizontal-black-no-bg-no-border-sm.png)
 
-Keep in mind it's an **instable** branch, everything can be broken :)
+# 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 -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 && make install
+make run
 ```
 
-## License
-Copyright © 2013-2015 Nicolas Lœuillet <nicolas@loeuillet.org>
+# 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.