README.md

   1 [![Build Status](https://api.travis-ci.org/wallabag/wallabag.svg?branch=master)](https://travis-ci.org/wallabag/wallabag)
   2 [![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)
   3 [![Gitter](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/wallabag/wallabag)
   4
   5 # What is wallabag?
   6 wallabag is a self-hostable PHP application allowing you to not miss any content anymore.
   7 Click, save and read it when you can. It extracts content so that you can read it when you have time.
   8
   9 More information on our website: [wallabag.org](https://wallabag.org).
  10
  11 If you do not have your own server, consider [the wallabag.it hosting solution](https://wallabag.it).
  12
  13 ![wallabag logo](https://raw.githubusercontent.com/wallabag/logo/master/_default/typo-horizontal/png/sm/logo-typo-horizontal-black-no-bg-no-border-sm.png)
  14
  15 # Install wallabag
  16 Please read [the documentation to see the wallabag requirements](https://doc.wallabag.org/en/admin/installation/requirements.html).
  17
  18 Then you can install wallabag by executing the following commands:
  19
  20 ```
  21 git clone https://github.com/wallabag/wallabag.git
  22 cd wallabag && make install
  23 ```
  24
  25 Now, [configure a virtual host](https://doc.wallabag.org/en/admin/installation/virtualhosts.html) to use your wallabag.
  26
  27 # Run on YunoHost
  28 [![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wallabag2)
  29
  30 Wallabag app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/wallabag2_ynh)
  31
  32 # License
  33 Copyright © 2013-2018 Nicolas Lœuillet <nicolas@loeuillet.org>
  34 This work is free. You can redistribute it and/or modify it under the
  35 terms of the MIT License. See the COPYING file for more details.