X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=ef1ecc4d1865381b0e9e7182c002000f3864a620;hb=2edde7fe337a8502ee5d37ae0b76f76295864b7c;hp=f4015620cef2959d6fa7c093fd35633721cb6e9c;hpb=7ce7ec4c942e0a3567858ad0ec8e654000b49a3f;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md index f4015620..ef1ecc4d 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,26 @@ -# poche -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). +# 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. + +## Some features +* 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: french, english, spanish, german. +* multi users (very soon!) +* update notification in configuration screen +* many storage modes (sqlite, mysql, postgresql) +* many templates: [have a look here](https://github.com/inthepoche/poche-themes). +* ... To test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche). -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). - -[![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. - -[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. - -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. - -Copy db/poche.sqlite.in to db/poche.sqlite - -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 : -```apache - - Order allow,deny - Deny from all - -``` - -Nginx version: -```nginx -location ~ /(db) { - deny all; - return 404; -} -``` +To use poche hosting, [you can create an account here](http://app.inthepoche.com/). -## Usage -See the documentation on our website : [inthepoche.com](http://inthepoche.com). +## Installation +Read the [INSTALL.md file](https://github.com/inthepoche/poche/blob/master/INSTALL.md). ## License Copyright © 2010-2013 Nicolas Lœuillet