X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=b1086885f4ca75b5eab547388982e6195c403aac;hb=ef186de38a28abf2979c19ff8933f07f296e80b8;hp=27f549d9116e6be4bddc9965323c7a56d2afd91e;hpb=9067b484ce8289eec6979cf6c8e3cbfb3bd5b10c;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md index 27f549d9..b1086885 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,25 @@ -# what is poche ? -Abandon Pocket, Instapaper and other Readability service : adopt poche. It is the same, but it is free (like in freedom) and 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) -## Some features +# 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. -* adding, deleting, archiving and setting as favorite a link -* import from pocket / readability / instapaper -* share links by email and on twitter -* a design adapted to tablets and smartphones -* extensions for Chrome and Firefox -* Android application -* multi languages (very soon!) -* multi users (very soon!) -* update notification in configuration screen -* many storage modes (sqlite, mysql, postgresql) -* many templates -* ... +More informations on our website: [wallabag.org](https://wallabag.org) -To test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche). +# Want to test the v2? +Keep in mind it's an **unstable** branch, everything can be broken :) -## Installation +If you don't have it yet, please [install composer](https://getcomposer.org/download/). Then you can install wallabag by executing the following commands: -Read the [INSTALL.md file](https://github.com/inthepoche/poche/blob/master/INSTALL.md). +``` +SYMFONY_ENV=prod composer create-project wallabag/wallabag wallabag "2.0.*@alpha" --no-dev +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.