X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=f463f79ad9a1cd1266fb756f55e404500ee51797;hb=refs%2Fheads%2Furl-3529;hp=b66aba185871c9723e39fbd6f68604121214d92d;hpb=1a268ba710b2cdb4ede98af3368c43d66c4c5e53;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md old mode 100755 new mode 100644 index b66aba18..f463f79a --- a/README.md +++ b/README.md @@ -1,13 +1,30 @@ -# poche +[![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) -Abandon Pocket, Instapaper and other Readibility service : adopt poche. It is the same, but it is open source. +# 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. -## Usage +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). -## License -Copyright © 2010-2013 Nicolas Lœuillet +![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). + +Then you can install wallabag by executing the following commands: + +``` +git clone https://github.com/wallabag/wallabag.git +cd wallabag && make install +``` + +Now, [configure a virtual host](https://doc.wallabag.org/en/admin/installation/virtualhosts.html) to use your wallabag. + +# License +Copyright © 2013-2018 Nicolas Lœuillet 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.