X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=09f48b17f600a99ba139d818dd49259d580bc085;hb=63c35580c7d60e2278ee6fe9ba2d4440ff0308d6;hp=1015085ac7b5f4a0f73a4d07e42bf9397cc7cf63;hpb=d178419c66fb1950aee7dc8e012c35f12f2a44bc;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md index 1015085a..09f48b17 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,33 @@ # 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) The website of poche is [inthepoche.com](http://inthepoche.com). -To get news from poche, [follow us on twitter](http://twitter.com/getpoche). +To test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche). -[If you want to flattr poche, it's here.](https://flattr.com/thing/1225780/nicosombpoche-on-GitHub) +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). -## 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 +[![flattr](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/1265480/poche-a-read-it-later-open-source-system) ## 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. +[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. -That's all, **poche works** ! +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. + +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 : @@ -36,9 +38,16 @@ You **have** to protect your db/poche.sqlite file. Modify the virtual host of yo ``` -## Import from Pocket +Nginx version: +```nginx +location ~ /(db) { + deny all; + return 404; +} +``` -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