aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas.loeuillet@gmail.com>2013-08-12 18:17:13 +0200
committerNicolas Lœuillet <nicolas.loeuillet@gmail.com>2013-08-12 18:17:13 +0200
commit86848edc843c42ce2cea8ccb14c44e52ba313219 (patch)
tree81ed2b8be9a03253b5744f2cb0501076f34ec438 /README.md
parentf93aaa65c4b5d359ee09d084d6a10601f31ddfeb (diff)
downloadwallabag-86848edc843c42ce2cea8ccb14c44e52ba313219.tar.gz
wallabag-86848edc843c42ce2cea8ccb14c44e52ba313219.tar.zst
wallabag-86848edc843c42ce2cea8ccb14c44e52ba313219.zip
upgrading README
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 18 insertions, 34 deletions
diff --git a/README.md b/README.md
index 689ad63b..27f549d9 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,26 @@
1# poche 1# what is poche ?
2Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source. Moreover, you can migrate from Pocket & Readability. 2Abandon 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![poche](http://inthepoche.com/img/logo.png) 4## Some features
5 5
6The 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
8To test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche). 19To test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche).
9 20
10To 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[![flattr](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/1265480/poche-a-read-it-later-open-source-system)
13
14## Installation 21## Installation
15 22
16Read the INSTALL.md file. 23Read the [INSTALL.md file](https://github.com/inthepoche/poche/blob/master/INSTALL.md).
17
18## Security
19You **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
27Nginx version:
28```nginx
29location ~ /(db) {
30 deny all;
31 return 404;
32}
33```
34
35## Usage
36See the documentation on our website : [inthepoche.com](http://inthepoche.com).
37
38## Travis
39[![Build Status](https://api.travis-ci.org/inthepoche/poche.png?branch=dev)](http://travis-ci.org/#!/inthepoche/poche)
40 24
41## License 25## License
42Copyright © 2010-2013 Nicolas Lœuillet <nicolas.loeuillet@gmail.com> 26Copyright © 2010-2013 Nicolas Lœuillet <nicolas.loeuillet@gmail.com>