]> git.immae.eu Git - github/wallabag/wallabag.git/blame_incremental - README.md
fixup! Fix documentation wording for matches/notmatches tagging rules
[github/wallabag/wallabag.git] / README.md
... / ...
CommitLineData
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?
6wallabag is a self-hostable PHP application allowing you to not miss any content anymore.
7Click, save and read it when you can. It extracts content so that you can read it when you have time.
8
9More information on our website: [wallabag.org](https://wallabag.org).
10
11If 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
16Please read [the documentation to see the wallabag requirements](http://doc.wallabag.org/en/master/user/installation.html#requirements).
17
18Then you can install wallabag by executing the following commands:
19
20```
21git clone https://github.com/wallabag/wallabag.git
22cd wallabag && make install
23```
24
25Now, [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
30Wallabag app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/wallabag2_ynh)
31
32# License
33Copyright © 2013-2018 Nicolas Lœuillet <nicolas@loeuillet.org>
34This work is free. You can redistribute it and/or modify it under the
35terms of the MIT License. See the COPYING file for more details.