X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=15c4ecb27484a14eae82f348f33439c0076780c5;hb=0452e869ec0e3d336337f815da346346c860d914;hp=bddb4d60473a4d621f5d2ddddd61e6f93d648537;hpb=7aa8ccc47d511f62fc46af53f7fc43d9bedebff3;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md index bddb4d60..15c4ecb2 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,35 @@ -# poche -Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source. Moreover, you can migrate from Pocket & Readability. +[![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) -![poche](http://inthepoche.com/img/logo.png) +# 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. -The website of poche is [inthepoche.com](http://inthepoche.com). +More information on our website: [wallabag.org](https://wallabag.org). -To test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche). +If you do not have your own server, consider [the wallabag.it hosting solution](https://wallabag.it). -To get news from poche, [follow us on twitter](http://twitter.com/getpoche) or [read the poche blog](http://inthepoche.com/blog). A Google Group is also available : [poche-users](https://groups.google.com/forum/#!forum/poche-users). +![wallabag logo](https://raw.githubusercontent.com/wallabag/logo/master/_default/typo-horizontal/png/sm/logo-typo-horizontal-black-no-bg-no-border-sm.png) -[![flattr](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/1265480/poche-a-read-it-later-open-source-system) +# Install wallabag +Please read [the documentation to see the wallabag requirements](http://doc.wallabag.org/en/master/user/installation.html#requirements). -## Security -You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition : -```apache - - Order allow,deny - Deny from all - -``` +Then you can install wallabag by executing the following commands: -Nginx version: -```nginx -location ~ /(db) { - deny all; - return 404; -} ``` +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. -## Usage -See the documentation on our website : [inthepoche.com](http://inthepoche.com). +# Run on YunoHost +[![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wallabag2) -## Travis -[![Build Status](http://travis-ci.org/inthepoche/poche.png)](http://travis-ci.org/#!/inthepoche/poche) +Wallabag app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/wallabag2_ynh) -## License -Copyright © 2010-2013 Nicolas Lœuillet +# 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.