X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=d1ed79eee3b13f296839e82be3bdd73c7aae9b93;hb=2b191d8c37bd774bd3eecbf42a5ac9d948ee61a9;hp=689ad63b5a924f84f92a17c9ce4c7e2ed2910ebb;hpb=82757801b9e9cdc8806c0005c290f05124f91ba6;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md index 689ad63b..d1ed79ee 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,29 @@ -# 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/tree/master/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) +To use poche hosting, [you can create an account here](http://app.inthepoche.com/). ## Installation - -Read the INSTALL.md file. - -## 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; -} -``` - -## Usage -See the documentation on our website : [inthepoche.com](http://inthepoche.com). - -## Travis -[![Build Status](https://api.travis-ci.org/inthepoche/poche.png?branch=dev)](http://travis-ci.org/#!/inthepoche/poche) +Read the [INSTALL.md file](https://github.com/inthepoche/poche/blob/master/INSTALL.md). ## License 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. \ No newline at end of file +as published by Sam Hocevar. See the COPYING file for more details.