diff options
author | Nicolas Lœuillet <nicolas.loeuillet@gmail.com> | 2013-08-08 09:36:10 -0700 |
---|---|---|
committer | Nicolas Lœuillet <nicolas.loeuillet@gmail.com> | 2013-08-08 09:36:10 -0700 |
commit | 9a8b4ff4edf84d7df60de1b6fd1e493b59f88273 (patch) | |
tree | 3c8ab8086fd8a2750270f8aeaee1f1ce016167cb /README.md | |
parent | 85ebc80c7eaf88e4d57a52adb8e4c32d8cc34b64 (diff) | |
parent | 572e758bf2e76308a3fa3eda9a8d9e9be8b53ecc (diff) | |
download | wallabag-9a8b4ff4edf84d7df60de1b6fd1e493b59f88273.tar.gz wallabag-9a8b4ff4edf84d7df60de1b6fd1e493b59f88273.tar.zst wallabag-9a8b4ff4edf84d7df60de1b6fd1e493b59f88273.zip |
Merge pull request #109 from inthepoche/dev
merge dev into master
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 30 |
1 files changed, 7 insertions, 23 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,24 +11,6 @@ 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 | ||
26 | You have to install [sqlite for php](http://www.php.net/manual/en/book.sqlite.php) on your server. | ||
27 | |||
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. | ||
29 | |||
30 | That's all, **poche works** ! | ||
31 | |||
32 | ## Security | 14 | ## Security |
33 | You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition : | 15 | You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition : |
34 | ```apache | 16 | ```apache |
@@ -46,12 +28,14 @@ location ~ /(db) { | |||
46 | } | 28 | } |
47 | ``` | 29 | ``` |
48 | 30 | ||
49 | ## Import from Pocket | 31 | ## Usage |
32 | See the documentation on our website : [inthepoche.com](http://inthepoche.com). | ||
50 | 33 | ||
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. | 34 | ## Travis |
35 | [![Build Status](https://api.travis-ci.org/inthepoche/poche.png?branch=dev)](http://travis-ci.org/#!/inthepoche/poche) | ||
52 | 36 | ||
53 | ## License | 37 | ## License |
54 | Copyright © 2010-2013 Nicolas Lœuillet <nicolas@loeuillet.org> | 38 | Copyright © 2010-2013 Nicolas Lœuillet <nicolas.loeuillet@gmail.com> |
55 | This work is free. You can redistribute it and/or modify it under the | 39 | 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, | 40 | 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. | 41 | as published by Sam Hocevar. See the COPYING file for more details. \ No newline at end of file |