Cleaned up documentation for installation process

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

diff --git a/README.md b/README.md
index 39d497d8f7a7e65c25ebf0b5b5a2f753f93e11f9..436272c03082e1fec3b317953515d58781a5de9b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,25 +1,28 @@
-[![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)
+[![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?
 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.
 
-More informations on our website: [wallabag.org](https://wallabag.org)
+More information on our website: [wallabag.org](https://wallabag.org).
 
-# Want to test the v2?
-Keep in mind it's an **unstable** branch, everything can be broken :)
+![wallabag logo](https://raw.githubusercontent.com/wallabag/logo/master/_default/typo-horizontal/png/sm/logo-typo-horizontal-black-no-bg-no-border-sm.png)
 
-If you don't have it yet, please [install composer](https://getcomposer.org/download/). Then you can install wallabag by executing the following commands:
+# 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:
 
 ```
-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
+    git clone https://github.com/wallabag/wallabag.git
+    cd wallabag
+    ./install.sh
+    php bin/console server:run --env=prod
 ```
 
-## License
+# 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.