# wallabag - Android App [![Build Status](https://travis-ci.org/wallabag/android-app.svg?branch=master)](https://travis-ci.org/wallabag/android-app)

<img src="/readme/wallabag logo.png" align="left"
width="200" hspace="10" vspace="10">

wallabag is a self-hosted read-it-later app.  
Unlike other services, wallabag is free and open source.  
wallabag for Android is a companion app for [wallabag](https://www.wallabag.org). You need a wallabag account first, which you are going to use in this app.

wallabag is available on the Google Play Store and F-Droid.

<p align="left">
<a href="https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche">
    <img alt="Get it on Google Play"
        height="80"
        src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" />
</a>  
<a href="https://f-droid.org/app/fr.gaulupeau.apps.InThePoche">
    <img alt="Get it on F-Droid"
        height="80"
        src="https://f-droid.org/badge/get-it-on.png" />
        </a>
        </p>

## About

wallabag has been made for you to comfortably read and archive your articles.
You can download wallabag from wallabag.org and follow the instructions to install it on your own server.
Alternatively, you can directly sign up for [wallabag.it](https://wallabag.it) or [Framabag](https://framabag.org).

This android application allows you to put a link in your wallabag instance, letting you read your wallabag links offline.

This application was originally created by Jonathan GAULUPEAU and released under the GNU GPLv3.
wallabag is a creation from Nicolas Lœuillet released under the MIT License (Expat License).

## Features

The android app lets you:
- Connect to your self-hosted wallabag instance or connect to your [wallabag.it](https://wallabag.it) or [Framabag](https://framabag.org) account.
- Supports wallabag 2.0 and higher.
- Completely ad-free.
- Increase and decrease the size of the font and also switch between a serif or sans-serif font for a more comfortable reading experience.
- Switch between numerous themes.
- Possibility to cache images locally for offline reading.
- Get articles read via Text-to-Speech feature.
- Needs no special permissions on Android 6.0+.

## Screenshots

[<img src="/readme/Wallabag%20Reading%20List.png" align="left"
width="200"
    hspace="10" vspace="10">](/readme/Wallabag%20Reading%20List.png)
[<img src="/readme/Wallabag%20Article%20View.png" align="center"
width="200"
    hspace="10" vspace="10">](/readme/Wallabag%20Article%20View.png)

## Permissions

On Android versions prior to Android 6.0, wallabag requires the following permissions:
- Full Network Access.
- View Network Connections.
- Run at startup.
- Read and write access to external storage.

The "Run at startup" permission is only used if Auto-Sync feature is enabled and is not utilised otherwise. The network access permissions are made use of for downloading content. The external storage permission is used to cache article images for viewing offline.

## Contributing

wallabag app is a free and open source project developed by volunteers. Any contributions are welcome. Here are a few ways you can help:
 * [Report bugs and make suggestions.](https://github.com/wallabag/android-app/issues)
 * [Translate the app](https://hosted.weblate.org/projects/wallabag/android-app/) (you don't have to create an account).
 * Write some code. Please follow the code style used in the project to make a review process faster.

## Credits  
Thanks to Michael Cook ([Twitter](https://twitter.com/mcookie)/[website](https://cookicons.co/)) for the app icon.

## License

This application is released under GNU GPLv3 (see [LICENSE](LICENSE)).
Some of the used libraries are released under different licenses.