X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=57392da2d10be75f5dc75048750e4f3e59d45517;hb=4fd5f670fe555da54c7a488b2a038a6ee36ee935;hp=1e33940a8de9fa70a9e4a31bfdfc8cbe90022951;hpb=de00c9208dddb7166eccdbf58fca1fafd9c7b392;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md index 1e33940a..57392da2 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,35 @@ -# 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=master) +[![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 PHP 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. -# Want to test the v2 ? +More information on our website: [wallabag.org](https://wallabag.org). -Keep in mind it's an **instable** branch, everything can be broken :) +If you do not have your own server, consider [the wallabag.it hosting solution](https://wallabag.it). + +![wallabag logo](https://raw.githubusercontent.com/wallabag/logo/master/_default/typo-horizontal/png/sm/logo-typo-horizontal-black-no-bg-no-border-sm.png) + +# Install wallabag +Please read [the documentation to see the wallabag requirements](https://doc.wallabag.org/en/admin/installation/requirements.html). + +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 ``` -## License -Copyright © 2013-2015 Nicolas Lœuillet +Now, [configure a virtual host](https://doc.wallabag.org/en/admin/installation/virtualhosts.html) to use your wallabag. + +# Run on YunoHost +[![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wallabag2) + +Wallabag app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/wallabag2_ynh) + +# License +Copyright © 2013-2018 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.