Merge branch 'master' of github.com:inthepoche/poche

[github/wallabag/wallabag.git] / README.md

diff --git a/README.md b/README.md
old mode 100755 (executable)
new mode 100644 (file)
index a03db98..34c45e6
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # poche
 Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source.
 
-![poche](http://cdetc.fr/poche/img/logo.png)
+![poche](http://inthepoche.com/img/logo.png)
 
 The website of poche is [inthepoche.com](http://inthepoche.com).
 
@@ -12,12 +12,21 @@ To get news from poche, [follow us on twitter](http://twitter.com/getpoche).
 ## 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
@@ -27,8 +36,20 @@ You **have** to protect your db/poche.sqlite file. Modify the virtual host of yo
 </Files>
 ```
 
+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.
+
 ## License
 Copyright © 2010-2013 Nicolas Lœuillet <nicolas@loeuillet.org>
 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.