diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 33 |
1 files changed, 16 insertions, 17 deletions
@@ -1,5 +1,5 @@ | |||
1 | # poche | 1 | # poche |
2 | Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source. | 2 | 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. |
3 | 3 | ||
4 | ![poche](http://inthepoche.com/img/logo.png) | 4 | ![poche](http://inthepoche.com/img/logo.png) |
5 | 5 | ||
@@ -11,23 +11,23 @@ To get news from poche, [follow us on twitter](http://twitter.com/getpoche) or [ | |||
11 | 11 | ||
12 | [![flattr](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/1265480/poche-a-read-it-later-open-source-system) | 12 | [![flattr](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/1265480/poche-a-read-it-later-open-source-system) |
13 | 13 | ||
14 | ## Usage | ||
15 | You can easily add a "poched" page with the bookmarklet. | ||
16 | |||
17 | poche save the entire content of a poched links : text and pictures are stored on your server. | ||
18 | |||
19 | You can : | ||
20 | * read a page in a comfortable reading view | ||
21 | * archive a link | ||
22 | * put a link in favorite | ||
23 | * delete a link | ||
24 | |||
25 | ## Requirements & installation | 14 | ## Requirements & installation |
26 | You have to install [sqlite for php](http://www.php.net/manual/en/book.sqlite.php) on your server. | 15 | You have to install [sqlite for php](http://www.php.net/manual/en/book.sqlite.php) on your server. |
27 | 16 | ||
17 | [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. | ||
18 | |||
28 | 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. | 19 | 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. |
29 | 20 | ||
30 | That's all, **poche works** ! | 21 | Install composer in your project : |
22 | ```bash | ||
23 | curl -s http://getcomposer.org/installer | php | ||
24 | ``` | ||
25 | Install via composer : | ||
26 | ```bash | ||
27 | php composer.phar install | ||
28 | ``` | ||
29 | |||
30 | That's all, you can use poche ! | ||
31 | 31 | ||
32 | ## Security | 32 | ## Security |
33 | You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition : | 33 | 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) { | |||
46 | } | 46 | } |
47 | ``` | 47 | ``` |
48 | 48 | ||
49 | ## Import from Pocket | 49 | ## Usage |
50 | 50 | See the documentation on our website : [inthepoche.com](http://inthepoche.com). | |
51 | 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. | ||
52 | 51 | ||
53 | ## License | 52 | ## License |
54 | Copyright © 2010-2013 Nicolas Lœuillet <nicolas@loeuillet.org> | 53 | Copyright © 2010-2013 Nicolas Lœuillet <nicolas@loeuillet.org> |
55 | This work is free. You can redistribute it and/or modify it under the | 54 | This work is free. You can redistribute it and/or modify it under the |
56 | terms of the Do What The Fuck You Want To Public License, Version 2, | 55 | terms of the Do What The Fuck You Want To Public License, Version 2, |
57 | as published by Sam Hocevar. See the COPYING file for more details. | 56 | as published by Sam Hocevar. See the COPYING file for more details. \ No newline at end of file |