X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=927f39a8871c42493579137f49427c4e7bab1881;hb=c7f622d3699b7f65ee75bcd5d409ad2027e9b6a4;hp=a03db980261e48e82c1c689145b7cbf3b406be56;hpb=9232dd8b2a599397aff61d5ffadd1b5f07d00d35;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md old mode 100755 new mode 100644 index a03db980..927f39a8 --- a/README.md +++ b/README.md @@ -1,34 +1,26 @@ -# 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. -The website of poche is [inthepoche.com](http://inthepoche.com). +More informations on our website: [wallabag.org](http://wallabag.org) -To get news from poche, [follow us on twitter](http://twitter.com/getpoche). +# Want to test the v2? -[If you want to flattr poche, it's here.](https://flattr.com/thing/1225780/nicosombpoche-on-GitHub) +Keep in mind it's an **unstable** branch, everything can be broken :) -## Usage -You can easily add a "poched" page with the bookmarklet. +If you don't have it yet, please [install composer](https://getcomposer.org/download/). Then you can install wallabag by executing the following commands: -You can : -* read a page in a comfortable reading view -* archive a link -* put a link in favorite -* delete a link - -## 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 - +``` +composer create-project wallabag/wallabag wallabag 2.0.0-alpha.1 +php bin/console wallabag:install +php bin/console server:run ``` ## 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.