diff --git a/.github/readme-images/app-icon.png b/.github/readme-images/app-icon.png new file mode 100644 index 0000000000..1939cc7efc Binary files /dev/null and b/.github/readme-images/app-icon.png differ diff --git a/.github/readme-images/screens.png b/.github/readme-images/screens.png new file mode 100644 index 0000000000..6a56ba99a1 Binary files /dev/null and b/.github/readme-images/screens.png differ diff --git a/README.md b/README.md index bd9961298c..712da4c7a0 100644 --- a/README.md +++ b/README.md @@ -2,24 +2,37 @@ |-------|----------|---------|------------|---------| | [![Travis](https://img.shields.io/travis/inorichi/tachiyomi.svg)](https://travis-ci.org/inorichi/tachiyomi) | [![stable release](https://img.shields.io/github/release/inorichi/tachiyomi.svg?maxAge=3600&label=stable)](https://github.com/inorichi/tachiyomi/releases) [![latest dev build](https://img.shields.io/badge/dev-latest%20build-blue.svg)](http://tachiyomi.kanade.eu/latest) | [![fdroid release](https://img.shields.io/badge/stable-f--droid.org-blue.svg)](https://f-droid.org/repository/browse/?fdid=eu.kanade.tachiyomi) [![fdroid dev](https://img.shields.io/badge/dev-wiki-blue.svg)](//github.com/inorichi/tachiyomi/wiki/FDroid-for-dev-versions) | [![Translation status](http://weblate.j2ghz.com/widgets/tachiyomi/-/svg-badge.svg)](https://github.com/inorichi/tachiyomi/wiki/Translation) | [![Discord](https://img.shields.io/discord/349436576037732353.svg)](https://discord.gg/2dDQBv2) | -### **Contact us on [Discord](https://discord.gg/WrBkRk4)** -If you want to open an issue, please read [contributing guidelines](https://github.com/inorichi/tachiyomi/blob/master/.github/CONTRIBUTING.md). Your issue may be closed otherwise. - -*** +# ![app icon](./.github/readme-images/app-icon.png)Tachiyomi Tachiyomi is a free and open source manga reader for Android. -Keep in mind it's still a beta, so expect it to crash sometimes. +![screenshots of app](./.github/readme-images/screens.png) -# Features +## Features -* Online and offline reading -* Configurable reader with multiple viewers and settings -* MyAnimeList support -* Resume from the next unread chapter -* Chapter filtering -* Schedule searching for updates +Features include: +* Online reading from sources like Batoto, KissManga, MangaFox, [and more](https://github.com/inorichi/tachiyomi-extensions) +* Local reading of downloaded manga +* Configurable reader with multiple viewers, reading directions and other settings +* MyAnimeList, AniList, and Kitsu support * Categories to organize your library +* Light and dark themes +* Schedule updating your library for new chapters +* Create backups locally or to your cloud service of choice + +## Download +Get the app from our [releases page](https://github.com/inorichi/tachiyomi/releases) or from [f-droid](https://f-droid.org/packages/eu.kanade.tachiyomi/). + +If you want to try new features before they get to the stable release, you can download the dev version [here](http://tachiyomi.kanade.eu/latest) (auto-updates not included), or add our [F-Droid repo](https://github.com/inorichi/tachiyomi/wiki/FDroid-for-dev-versions). + +## Issues, Feature Requests and Contributing + +If you want to open an issue, please read [contributing guidelines](https://github.com/inorichi/tachiyomi/blob/master/.github/CONTRIBUTING.md). Your issue may be closed otherwise. + +## FAQ + +[See our wiki.](https://github.com/inorichi/tachiyomi/wiki/FAQ) +You can also reach out to us on [Discord](https://discord.gg/WrBkRk4). ## License