X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=6d545ff51d0ceb72303528b809485e45f9e21981;hb=5c895a7fd15822856fb407910264c5d95e1e223c;hp=583842ece103572adc397e7e3449ffcf68ce6519;hpb=33e38dd0ce6b7201c03711816c0e7878f1660fa6;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md old mode 100755 new mode 100644 index 583842ec..6d545ff5 --- a/README.md +++ b/README.md @@ -1,30 +1,27 @@ -# 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) +[![Code Coverage](https://scrutinizer-ci.com/g/wallabag/wallabag/badges/coverage.png?b=v2)](https://scrutinizer-ci.com/g/wallabag/wallabag/?branch=v2) +[![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) -![poche](http://cdetc.fr/poche/img/logo.png) +# 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. -To get news from poche, [follow us on twitter](http://twitter.com/getpoche). +More informations on our website: [wallabag.org](http://wallabag.org) -## Usage -You can easily add a "poched" page with the bookmarklet. +# Want to test the v2? -You can : -* read a page in a comfortable reading view -* archive a link -* put a link in favorite -* delete a link +Keep in mind it's an **unstable** branch, everything can be broken :) -## 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: + +``` +composer create-project wallabag/wallabag wallabag 2.0.0-alpha.1 +cd wallabag +php app/console wallabag:install +php app/console server:run ``` ## License -Copyright © 2010-2013 Nicolas Lœuillet +Copyright © 2013-2015 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.