X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=689ad63b5a924f84f92a17c9ce4c7e2ed2910ebb;hb=fa0483b3611670f6ef5811fab6afd1c9bc35a515;hp=7ce5d131d5d56a003d9448eb90ec987bc0852e81;hpb=66ce09ba038baf7ab729384f05dfcb2bdda03ea5;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md index 7ce5d131..689ad63b 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,13 @@ 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). A Google Group is also available : [https://groups.google.com/forum/#!forum/poche-users](https://groups.google.com/forum/#!forum/poche-users) +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 +## Installation -## 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** ! +Read the INSTALL.md file. ## Security You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition : @@ -46,12 +32,14 @@ location ~ /(db) { } ``` -## Import from Pocket +## Usage +See the documentation on our website : [inthepoche.com](http://inthepoche.com). -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. +## Travis +[![Build Status](https://api.travis-ci.org/inthepoche/poche.png?branch=dev)](http://travis-ci.org/#!/inthepoche/poche) ## License -Copyright © 2010-2013 Nicolas Lœuillet +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