X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=0936f666bad3656562c3879388d6a007819efc30;hb=57386125abc5c50c1438cf7e78d01f06021adc0a;hp=1015085ac7b5f4a0f73a4d07e42bf9397cc7cf63;hpb=d178419c66fb1950aee7dc8e012c35f12f2a44bc;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md index 1015085a..0936f666 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,27 @@ -# 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://inthepoche.com/img/logo.png) +# What is wallabag? +wallabag is a self hostable 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 informations on our website: [wallabag.org](https://wallabag.org) -To get news from poche, [follow us on twitter](http://twitter.com/getpoche). +# Install wallabag -[If you want to flattr poche, it's here.](https://flattr.com/thing/1225780/nicosombpoche-on-GitHub) +If you don't have it yet, please [install composer](https://getcomposer.org/download/) or be sure to use Composer 1.2 (`composer selfupdate` can help you about that). Read [our documentation](http://doc.wallabag.org) to have more information about installation. +Then you can install wallabag by executing the following commands: -## Usage -You can easily add a "poched" page with the bookmarklet. - -poche save the entire content of a poched links : text and pictures are stored on your server. - -You can : -* read a page in a comfortable reading view -* archive a link -* put a link in favorite -* delete a link - -## Requirements & installation -You have to install [sqlite for php](http://www.php.net/manual/en/book.sqlite.php) on your server. - -Get the [latest version](https://github.com/nicosomb/poche) of poche on github. Unzip it and upload it on your server. poche must have write access on assets, cache and db directories. - -That's all, **poche works** ! - -## 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 - ``` - -## Import from Pocket - -If you want to import your Pocket datas, [export them here](https://getpocket.com/export). Put the HTML file in your poche directory, execute import.php file locally by following instructions. Be careful, the script can take a very long time. + git clone https://github.com/wallabag/wallabag.git + cd wallabag + git checkout 2.1.0 + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console server:run --env=prod +``` ## License -Copyright © 2010-2013 Nicolas Lœuillet +Copyright © 2013-2016 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.