Merge branch 'v2' into patch-1

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

diff --git a/README.md b/README.md
old mode 100755 (executable)
new mode 100644 (file)
index e0712ad..07b4cb7
--- a/README.md
+++ b/README.md
@@ -1,13 +1,25 @@
-# poche
+[![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)
 
-Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source.
+# 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.
 
-## Usage
+More informations 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 :)
+
+If you don't have it yet, please [install composer](https://getcomposer.org/download/). 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
+php bin/console server:run
+```
 
 ## License
-Copyright © 2010-2013 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 Do What The Fuck You Want To Public License, Version 2,
-as published by Sam Hocevar. See the COPYING file for more details.
\ No newline at end of file
+terms of the MIT License. See the COPYING file for more details.