X-Git-Url: https://git.immae.eu/?p=github%2Fwallabag%2Fwallabag.git;a=blobdiff_plain;f=README.md;h=57392da2d10be75f5dc75048750e4f3e59d45517;hp=c948828843bc043589ba6217dcb6f437ee8c470b;hb=HEAD;hpb=7c1225347db8b516cc268709939f6b359bc283c1 diff --git a/README.md b/README.md index c9488288..e00c7ea0 100644 --- a/README.md +++ b/README.md @@ -3,25 +3,33 @@ [![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. +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. 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). + ![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](http://doc.wallabag.org/en/master/user/installation.html#requirements). +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 cd wallabag && make install -make run ``` +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-2016 Nicolas Lœuillet +Copyright © 2013-current 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.