X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=2a7b54bf78b89aa793ecf652d2044e1e26cf204f;hb=5ecdfcd041767c9e3244a92bb0a6cc3c3f80fea3;hp=d1ed79eee3b13f296839e82be3bdd73c7aae9b93;hpb=7d7ed6a0ee869faf2ab04747f68c3fc6bdda7550;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md index d1ed79ee..2a7b54bf 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,28 @@ -# 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://api.travis-ci.org/wallabag/wallabag.svg?branch=master)](https://travis-ci.org/wallabag/wallabag) +[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/wallabag/wallabag/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/wallabag/wallabag/?branch=v2) +[![Gitter](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/wallabag/wallabag) -## Some features -* 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: french, english, spanish, german. -* multi users (very soon!) -* update notification in configuration screen -* many storage modes (sqlite, mysql, postgresql) -* many templates: [have a look here](https://github.com/inthepoche/poche/tree/master/themes). -* ... +# 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 test poche, a demo website is online : [demo.inthepoche.com](http://demo.inthepoche.com) (login poche, password poche). +More informations on our website: [wallabag.org](https://wallabag.org) -To use poche hosting, [you can create an account here](http://app.inthepoche.com/). +# Install wallabag -## Installation -Read the [INSTALL.md file](https://github.com/inthepoche/poche/blob/master/INSTALL.md). +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.5 + 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. +terms of the MIT License. See the COPYING file for more details.