diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 52 |
1 files changed, 18 insertions, 34 deletions
| @@ -1,42 +1,26 @@ | |||
| 1 | # poche | 1 | # what is poche ? |
| 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. | 2 | Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is free (like in freedom) and open source. |
| 3 | 3 | ||
| 4 |  | 4 | ## Some features |
| 5 | 5 | ||
| 6 | The website of poche is [inthepoche.com](http://inthepoche.com). | 6 | * adding, deleting, archiving and setting as favorite a link |
| 7 | * import from pocket / readability / instapaper | ||
| 8 | * share links by email and on twitter | ||
| 9 | * a design adapted to tablets and smartphones | ||
| 10 | * extensions for Chrome and Firefox | ||
| 11 | * Android application | ||
| 12 | * multi languages (very soon!) | ||
| 13 | * multi users (very soon!) | ||
| 14 | * update notification in configuration screen | ||
| 15 | * many storage modes (sqlite, mysql, postgresql) | ||
| 16 | * many templates | ||
| 17 | * ... | ||
| 7 | 18 | ||
| 8 | To test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche). | 19 | To test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche). |
| 9 | 20 | ||
| 10 | 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). | ||
| 11 | |||
| 12 | [](http://flattr.com/thing/1265480/poche-a-read-it-later-open-source-system) | ||
| 13 | |||
| 14 | ## Installation | 21 | ## Installation |
| 15 | 22 | ||
| 16 | Read the INSTALL.md file. | 23 | Read the [INSTALL.md file](https://github.com/inthepoche/poche/blob/master/INSTALL.md). |
| 17 | |||
| 18 | ## Security | ||
| 19 | You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition : | ||
| 20 | ```apache | ||
| 21 | <Files ~ "\.sqlite$"> | ||
| 22 | Order allow,deny | ||
| 23 | Deny from all | ||
| 24 | </Files> | ||
| 25 | ``` | ||
| 26 | |||
| 27 | Nginx version: | ||
| 28 | ```nginx | ||
| 29 | location ~ /(db) { | ||
| 30 | deny all; | ||
| 31 | return 404; | ||
| 32 | } | ||
| 33 | ``` | ||
| 34 | |||
| 35 | ## Usage | ||
| 36 | See the documentation on our website : [inthepoche.com](http://inthepoche.com). | ||
| 37 | |||
| 38 | ## Travis | ||
| 39 | [](http://travis-ci.org/#!/inthepoche/poche) | ||
| 40 | 24 | ||
| 41 | ## License | 25 | ## License |
| 42 | Copyright © 2010-2013 Nicolas Lœuillet <nicolas.loeuillet@gmail.com> | 26 | Copyright © 2010-2013 Nicolas Lœuillet <nicolas.loeuillet@gmail.com> |