X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=1b20e5d1cd383a285046b8bf64139ad87b530223;hb=a7c8f5457014f5dd6370323e9aad61d0d08848ee;hp=1e33940a8de9fa70a9e4a31bfdfc8cbe90022951;hpb=3bb7c5ffeceac653b014aa515ed7e50cfe25c392;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md index 1e33940a..1b20e5d1 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,29 @@ -# What is wallabag ? +[![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, 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 information on our website: [wallabag.org](https://wallabag.org). + +If you do not have your own server, consider [the wallabag.it hosting solution](https://wallabag.it). -More informations on our website: [wallabag.org](http://wallabag.org) +![wallabag logo](https://raw.githubusercontent.com/wallabag/logo/master/_default/typo-horizontal/png/sm/logo-typo-horizontal-black-no-bg-no-border-sm.png) -# Want to test the v2 ? +# Install wallabag +Please read [the documentation to see the wallabag requirements](http://doc.wallabag.org/en/master/user/installation.html#requirements). -Keep in mind it's an **instable** branch, everything can be broken :) +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 +# License +Copyright © 2013-2017 Nicolas Lœuillet 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.