FIX image inside a figure element max-width

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

diff --git a/README.md b/README.md
index 4dc135222d8a51f93248882f5369d44080f9e09f..0d87d7bb332210eb6bfe09f418d86297a60f11f1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,10 +1,28 @@
-# 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.
+[![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)
 
-More informations on our website: [wallabag.org](http://wallabag.org)
+# 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)
+
+# Install wallabag
+
+If you don't have it yet, please [install composer](https://getcomposer.org/download/) or be sure to use Composer 1.2 (`composer selfupdate` can help you about that).
+Then you can install wallabag by executing the following commands:
+
+```
+    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 © 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.