X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=15c4ecb27484a14eae82f348f33439c0076780c5;hb=0452e869ec0e3d336337f815da346346c860d914;hp=b58f91f1e980219ad6ea2c25dd315d04b148f371;hpb=27574abf4678f8b5eb731ed9cf7157e2fdb1f30d;p=github%2Fwallabag%2Fwallabag.git diff --git a/README.md b/README.md index b58f91f1..15c4ecb2 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,35 @@ -# 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=master) +[![Gitter](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/wallabag/wallabag) -## Some features +# What is wallabag? +wallabag is a self-hostable PHP 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: 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-themes). -* ... +More information 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). +If you do not have your own server, consider [the wallabag.it hosting solution](https://wallabag.it). -## Installation +![wallabag logo](https://raw.githubusercontent.com/wallabag/logo/master/_default/typo-horizontal/png/sm/logo-typo-horizontal-black-no-bg-no-border-sm.png) -Read the [INSTALL.md file](https://github.com/inthepoche/poche/blob/master/INSTALL.md). +# Install wallabag +Please read [the documentation to see the wallabag requirements](http://doc.wallabag.org/en/master/user/installation.html#requirements). -## License -Copyright © 2010-2013 Nicolas Lœuillet +Then you can install wallabag by executing the following commands: + +``` +git clone https://github.com/wallabag/wallabag.git +cd wallabag && make install +``` + +Now, [configure a virtual host](https://doc.wallabag.org/en/admin/installation/virtualhosts.html) to use your wallabag. + +# Run on YunoHost +[![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wallabag2) + +Wallabag app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/wallabag2_ynh) + +# License +Copyright © 2013-2018 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.