X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=70a07648a5d94a0dfef15cbb95297ff0bb9d3930;hb=eff75729a119c429e1eb526739fd45ff9aa18885;hp=2e14888cd4ffd2b1cbe2b979b1743203fac8eb0d;hpb=28cbf46cf5bae81b6fe25c89237d0a005281086a;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md old mode 100755 new mode 100644 index 2e14888c..0e59e40f --- a/README.md +++ b/README.md @@ -1,28 +1,28 @@ -# poche -Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is open source. +[![Build Status](https://travis-ci.org/wallabag/wallabag.svg?branch=v2)](https://travis-ci.org/wallabag/wallabag) +[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/wallabag/wallabag/badges/quality-score.png?b=v2)](https://scrutinizer-ci.com/g/wallabag/wallabag/?branch=v2) +[![Gitter](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/wallabag/wallabag) -To get news from poche, [follow us on twitter](http://twitter.com/getpoche). +# What is wallabag? +wallabag is a self hostable application allowing you to not miss any content anymore. +Click, save and read it when you can. It extracts content so that you can read it when you have time. -## Usage -You can easily add a "poched" page with the bookmarklet. +More informations on our website: [wallabag.org](https://wallabag.org) -You can : -* read a page in a comfortable reading view -* archive a link -* put a link in favorite -* delete a link +# Install wallabag -## 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 - +If you don't have it yet, please [install composer](https://getcomposer.org/download/). +Then you can install wallabag by executing the following commands: + +``` + git clone https://github.com/wallabag/wallabag.git + cd wallabag + git checkout 2.0.0 + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console wallabag:install --env=prod + php bin/console server:run --env=prod ``` ## License -Copyright © 2010-2013 Nicolas Lœuillet +Copyright © 2013-2016 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 +terms of the MIT License. See the COPYING file for more details.