wallabag/README.md

[![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)

# 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.

More information on our website: [wallabag.org](https://wallabag.org).

If you do not have your own server, consider [the wallabag.it hosting solution](https://wallabag.it).

![wallabag logo](https://raw.githubusercontent.com/wallabag/logo/master/_default/typo-horizontal/png/sm/logo-typo-horizontal-black-no-bg-no-border-sm.png)

# Install wallabag
Please read [the documentation to see the wallabag requirements](https://doc.wallabag.org/en/admin/installation/requirements.html).

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-current Nicolas Lœuillet <nicolas@loeuillet.org>
This work is free. You can redistribute it and/or modify it under the
terms of the MIT License. See the COPYING file for more details.
Change Travis/Scrutinizer pictures in README 2016-05-05 13:21:12 +00:00			`[![Build Status](https://api.travis-ci.org/wallabag/wallabag.svg?branch=master)](https://travis-ci.org/wallabag/wallabag)`
Changed URL for scrutinizer in README 2016-08-11 18:57:06 +00:00			`[![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)`
Add @GitterHQ badge on README 2016-01-24 19:02:31 +00:00			`[![Gitter](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/wallabag/wallabag)`
Add Travis & Scrutinizer badges 2015-04-02 09:45:53 +00:00
Fix typo and set version in the README 2016-01-13 23:41:08 +00:00			`# What is wallabag?`
Update Readme with crucial information 2017-08-10 18:54:58 +00:00			`wallabag is a self-hostable PHP application allowing you to not miss any content anymore.`
Fix typo and set version in the README 2016-01-13 23:41:08 +00:00			`Click, save and read it when you can. It extracts content so that you can read it when you have time.`
upgrading README 2013-08-12 16:17:13 +00:00
Cleaned up documentation for installation process 2016-10-08 13:10:56 +00:00			`More information on our website: [wallabag.org](https://wallabag.org).`

Added wallabag.it link in README 2017-02-18 14:04:57 +00:00			`If you do not have your own server, consider [the wallabag.it hosting solution](https://wallabag.it).`

Cleaned up documentation for installation process 2016-10-08 13:10:56 +00:00			`![wallabag logo](https://raw.githubusercontent.com/wallabag/logo/master/_default/typo-horizontal/png/sm/logo-typo-horizontal-black-no-bg-no-border-sm.png)`
preparing travis 2013-08-08 05:16:07 +00:00
:rocket: Prepare v2.0.0 :birthday: 2016-04-03 08:08:22 +00:00			`# Install wallabag`
Fix link to wallabag requirements in documentation 2018-11-05 09:17:50 +00:00			`Please read [the documentation to see the wallabag requirements](https://doc.wallabag.org/en/admin/installation/requirements.html).`
Fix typo and set version in the README 2016-01-13 23:41:08 +00:00
Prepare files for 2.0.0-beta.2 2016-03-08 10:40:37 +00:00			`Then you can install wallabag by executing the following commands:`
Installation should be launch manually Also upadte readme for v2 and define a test database (for the future) 2015-02-02 06:48:13 +00:00
			```
Update README.md 2016-10-10 07:11:26 +00:00			`git clone https://github.com/wallabag/wallabag.git`
Cleanup 2018-10-24 19:02:35 +00:00			`cd wallabag && make install`
Installation should be launch manually Also upadte readme for v2 and define a test database (for the future) 2015-02-02 06:48:13 +00:00			```

Cleanup 2018-10-24 19:02:35 +00:00			`Now, [configure a virtual host](https://doc.wallabag.org/en/admin/installation/virtualhosts.html) to use your wallabag.`
Removed "make run" in the README 2017-12-12 19:52:05 +00:00
Propose YunoHost badge for installing The YunoHost have working Wallabag package with working install,remove,update,backup and restore scripts. YunoHost makes self -hosting easy for the end users. Please add the this badge so that people can find this solution. 2018-06-21 21:13:43 +00:00			`# 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)`

Cleaned up documentation for installation process 2016-10-08 13:10:56 +00:00			`# License`
Cleanup 2018-10-24 19:02:35 +00:00			`Copyright © 2013-current Nicolas Lœuillet <nicolas@loeuillet.org>`
first commit 2013-04-03 13:14:01 +00:00			`This work is free. You can redistribute it and/or modify it under the`
WHAT. A. BIG. REFACTOR. + new license (we moved to MIT one) 2014-07-11 14:03:59 +00:00			`terms of the MIT License. See the COPYING file for more details.`