X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=b1086885f4ca75b5eab547388982e6195c403aac;hb=ef186de38a28abf2979c19ff8933f07f296e80b8;hp=70a07648a5d94a0dfef15cbb95297ff0bb9d3930;hpb=8d5aab49c185313338245f9c3a878628e16d7c85;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md index 70a07648..b1086885 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,25 @@ -# poche -Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source. +[![Build Status](https://travis-ci.org/wallabag/wallabag.svg?branch=v2)](https://travis-ci.org/wallabag/wallabag) +[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/wallabag/wallabag/badges/quality-score.png?b=v2)](https://scrutinizer-ci.com/g/wallabag/wallabag/?branch=v2) +[![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 test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche). +# Want to test the v2? +Keep in mind it's an **unstable** branch, everything can be broken :) -To get news from poche, [follow us on twitter](http://twitter.com/getpoche) or [read the poche blog](http://inthepoche.com/blog). +If you don't have it yet, please [install composer](https://getcomposer.org/download/). Then you can install wallabag by executing the following commands: -[![flattr](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/1265480/poche-a-read-it-later-open-source-system) - -## 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/inthepoche/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 - ``` - -Nginx version: -```nginx -location ~ /(db) { - deny all; - return 404; -} +SYMFONY_ENV=prod composer create-project wallabag/wallabag wallabag "2.0.*@alpha" --no-dev +php bin/console wallabag:install --env=prod +php bin/console server:run --env=prod ``` -## 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. - ## 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. +terms of the MIT License. See the COPYING file for more details.