X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=57392da2d10be75f5dc75048750e4f3e59d45517;hb=f6b9e883c01196d5aec249f6e8e02e07d0da4089;hp=a03db980261e48e82c1c689145b7cbf3b406be56;hpb=9232dd8b2a599397aff61d5ffadd1b5f07d00d35;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md old mode 100755 new mode 100644 index a03db980..57392da2 --- a/README.md +++ b/README.md @@ -1,34 +1,35 @@ -# poche -Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source. +[![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://cdetc.fr/poche/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 get news from poche, [follow us on twitter](http://twitter.com/getpoche). +If you do not have your own server, consider [the wallabag.it hosting solution](https://wallabag.it). -[If you want to flattr poche, it's here.](https://flattr.com/thing/1225780/nicosombpoche-on-GitHub) +![wallabag logo](https://raw.githubusercontent.com/wallabag/logo/master/_default/typo-horizontal/png/sm/logo-typo-horizontal-black-no-bg-no-border-sm.png) -## Usage -You can easily add a "poched" page with the bookmarklet. +# Install wallabag +Please read [the documentation to see the wallabag requirements](https://doc.wallabag.org/en/admin/installation/requirements.html). -You can : -* read a page in a comfortable reading view -* archive a link -* put a link in favorite -* delete a link +Then you can install wallabag by executing the following commands: -## 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 - ``` +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. + +# 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 © 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.