X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=27f549d9116e6be4bddc9965323c7a56d2afd91e;hb=fd99a8c02d7c625771656a5c5081560027d8e6e9;hp=34c45e63222177256ba8ba40c99f6a19f74b3d07;hpb=dbb792bf2dd51771ec95f674aaea9ee501ac1d73;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md index 34c45e63..27f549d9 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,29 @@ -# poche -Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source. +# what is poche ? +Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is free (like in freedom) and open source. -![poche](http://inthepoche.com/img/logo.png) +## Some features -The website of poche is [inthepoche.com](http://inthepoche.com). +* adding, deleting, archiving and setting as favorite a link +* import from pocket / readability / instapaper +* share links by email and on twitter +* a design adapted to tablets and smartphones +* extensions for Chrome and Firefox +* Android application +* multi languages (very soon!) +* multi users (very soon!) +* update notification in configuration screen +* many storage modes (sqlite, mysql, postgresql) +* many templates +* ... -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) +## Installation -## 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 - -## 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. - -That's all, **poche works** ! - -## Security -You **have** to protect your db/poche.sqlite file. Modify the virtual host of your website to add this condition : -```apache - - Order allow,deny - Deny from all - -``` - -Nginx version: -```nginx -location ~ /(db) { - deny all; - return 404; -} -``` - -## Import from Pocket - -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. +Read the [INSTALL.md file](https://github.com/inthepoche/poche/blob/master/INSTALL.md). ## 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