X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=09f48b17f600a99ba139d818dd49259d580bc085;hb=7f959169b7220b4ed3e083cb2a545fe2c5400f9c;hp=70a07648a5d94a0dfef15cbb95297ff0bb9d3930;hpb=8d5aab49c185313338245f9c3a878628e16d7c85;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md index 70a07648..09f48b17 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # poche -Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source. +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. ![poche](http://inthepoche.com/img/logo.png) @@ -7,27 +7,27 @@ The website of poche is [inthepoche.com](http://inthepoche.com). To test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche). -To get news from poche, [follow us on twitter](http://twitter.com/getpoche) or [read the poche blog](http://inthepoche.com/blog). +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). [![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. +[PHP cURL](http://www.php.net/manual/en/book.curl.php) & [tidy_parse_string](http://www.php.net/manual/en/tidy.parsestring.php) are recommended. + 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** ! +Install composer in your project : +```bash +curl -s http://getcomposer.org/installer | php +``` +Install via composer : +```bash +php composer.phar install +``` + +That's all, you can use poche ! ## Security You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition : @@ -46,12 +46,11 @@ location ~ /(db) { } ``` -## 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. +## Usage +See the documentation on our website : [inthepoche.com](http://inthepoche.com). ## License Copyright © 2010-2013 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. +as published by Sam Hocevar. See the COPYING file for more details. \ No newline at end of file