]> git.immae.eu Git - github/wallabag/wallabag.git/blob - README.md
Merge pull request #2372 from pmartin/api-get-entry-as-epub
[github/wallabag/wallabag.git] / 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 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 ![wallabag logo](https://raw.githubusercontent.com/wallabag/logo/master/_default/typo-horizontal/png/sm/logo-typo-horizontal-black-no-bg-no-border-sm.png)
12
13 # Install wallabag
14 Please read [the documentation to see the wallabag requirements](http://doc.wallabag.org/en/master/user/installation.html#requirements).
15
16 Then you can install wallabag by executing the following commands:
17
18 ```
19 git clone https://github.com/wallabag/wallabag.git
20 cd wallabag && make install
21 make run
22 ```
23
24 # License
25 Copyright © 2013-2016 Nicolas Lœuillet <nicolas@loeuillet.org>
26 This work is free. You can redistribute it and/or modify it under the
27 terms of the MIT License. See the COPYING file for more details.