Windy/komga
1
0
Fork 0
mirror of https://github.com/gotson/komga.git synced 2025-01-09 04:08:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

add documentation on how to configure Tachiyomi extension

Browse Source 
[ci skip]
This commit is contained in:
Gauthier Roebroeck 2019-09-24 10:14:49 +08:00
parent 9f923bf793
commit 94148f5f59
2 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
.github/readme-images/tachiyomi-extension-configuration.jpg vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 29 KiB

12
README.md
View File

@ -17,12 +17,11 @@ Komga just started, and for now it can:
## Status & vision
The first version is a simple server with only an API and no UI.
It's aimed to work with [Tachiyomi](https://github.com/inorichi/tachiyomi) through an extension.
For now Komga is a simple server without user interface, providing an API and OPDS feed. It can work with [Tachiyomi](https://github.com/inorichi/tachiyomi) through the official extension, as well as most OPDS readers.
Future versions may bring:
- support for multiple libraries (multiple folders)
- support for multiple libraries (multiple root folders)
- a web UI to administrate the server
- matching with online metadata sources (like ComicVine) to enrich information like description or genre
@ -99,6 +98,13 @@ On rescans, Komga will update Series and Books, add new ones, and remove the one
Then it will _parse_ each book, which consist of indexing pages (images in the archive), and generating a thumbnail.
## Tachiyomi configuration
Komga has an official extension for [Tachiyomi](https://github.com/inorichi/tachiyomi), available from within Tachiyomi's extension menu.
The extension is configurable, you need to specify the `server address`, `username`, and `password`.
![tachiyomi extension configuration screenshot](./.github/readme-images/tachiyomi-extension-configuration.jpg)
## APIs
### Native API