doc: Add Neko integration instructions (#1440)

* doc: Add Neko integration instructions

* Update README.md

---------

Co-authored-by: Mitchell Syer <Syer10@users.noreply.github.com>
This commit is contained in:
David Brochero
2025-06-12 12:40:30 -03:00
committed by GitHub
parent 31f06a2d43
commit a5cf428ce5

View File

@@ -5,27 +5,34 @@
## Table of Content ## Table of Content
- [What is Suwayomi?](#what-is-suwayomi) - [What is Suwayomi?](#what-is-suwayomi)
- [Features](#Features) - [Features](#features)
- [Suwayomi client projects](#Suwayomi-client-projects) - [Suwayomi client projects](#suwayomi-client-projects)
- [Actively Developed Clients](#actively-developed-clients)
- [Inactive Clients (functional but outdated)](#inactive-clients-functional-but-outdated)
- [Abandoned Clients (functionality unknown)](#abandoned-clients-functionality-unknown)
- [Downloading and Running the app](#downloading-and-running-the-app) - [Downloading and Running the app](#downloading-and-running-the-app)
* [Using Operating System Specific Bundles](#using-operating-system-specific-bundles) - [Using Operating System Specific Bundles](#using-operating-system-specific-bundles)
- [Launcher Scripts](#launcher-scripts) - [Windows](#windows)
+ [Windows](#windows) - [macOS](#macos)
+ [macOS](#macos) - [GNU/Linux](#gnulinux)
+ [GNU/Linux](#gnulinux) - [Other methods of getting Suwayomi](#other-methods-of-getting-suwayomi)
* [Other methods of getting Suwayomi](#other-methods-of-getting-suwayomi) - [Docker](#docker)
+ [Arch Linux](#arch-linux) - [Arch Linux](#arch-linux)
+ [Ubuntu-based distributions](#ubuntu-based-distributions) - [Debian/Ubuntu](#debianubuntu)
+ [Docker](#docker) - [NixOS](#nixos)
* [Advanced Methods](#advanced-methods) - [Advanced Methods](#advanced-methods)
+ [Running the jar release directly](#running-the-jar-release-directly) - [Running the jar release directly](#running-the-jar-release-directly)
+ [Using Suwayomi Remotely](#using-suwayomi-remotely) - [Using Suwayomi Remotely](#using-suwayomi-remotely)
- [Syncing With Mihon (Tachiyomi)](#syncing-with-mihon-tachiyomi) - [Syncing With Mihon (Tachiyomi) and Neko](#syncing-with-mihon-tachiyomi-and-neko)
- [Troubleshooting and Support](#troubleshooting-and-support) - [The Suwayomi extension and tracker](#the-suwayomi-extension-and-tracker)
- [Contributing and Technical info](#contributing-and-technical-info) - [The Suwayomi merge source in Neko](#the-suwayomi-merge-source-in-neko)
- [Translation](#translation) - [Other methods](#other-methods)
- [Credit](#credit) - [Troubleshooting and Support](#troubleshooting-and-support)
- [License](#license) - [Contributing and Technical info](#contributing-and-technical-info)
- [Translation](#translation)
- [Credit](#credit)
- [License](#license)
- [Disclaimer](#disclaimer)
<!-- Generated with https://ecotrust-canada.github.io/markdown-toc/ --> <!-- Generated with https://ecotrust-canada.github.io/markdown-toc/ -->
# What is Suwayomi? # What is Suwayomi?
@@ -176,9 +183,9 @@ Check out [this wiki page](https://github.com/Suwayomi/Suwayomi-Server/wiki/Conf
If you face issues with your setup then we are happy to provide help, just join our discord server(a discord badge is on the top of the page, you are just a click-clack away!). If you face issues with your setup then we are happy to provide help, just join our discord server(a discord badge is on the top of the page, you are just a click-clack away!).
## Syncing With Mihon (Tachiyomi) ## Syncing With Mihon (Tachiyomi) and Neko
### The Suwayomi extension and tracker ### The Suwayomi extension and tracker
- You can install the `Suwayomi` extension inside Mihon (Tachiyomi). - You can install and configure the `Suwayomi` [extension](https://github.com/Suwayomi/tachiyomi-extension) inside Mihon (Tachiyomi) and forks.
- The extension will load your Suwayomi library. - The extension will load your Suwayomi library.
- By manipulating extension search filters you can browse your categories. - By manipulating extension search filters you can browse your categories.
- You can enable the Suwayomi tracker to track reading progress with your Suwayomi server. - You can enable the Suwayomi tracker to track reading progress with your Suwayomi server.
@@ -186,6 +193,15 @@ If you face issues with your setup then we are happy to provide help, just join
- Mihon (Tachiyomi) to Suwayomi: Mihon (Tachiyomi) automatically updates the chapters read status when it's updating the tracker (e.g. while reading) - Mihon (Tachiyomi) to Suwayomi: Mihon (Tachiyomi) automatically updates the chapters read status when it's updating the tracker (e.g. while reading)
- Suwayomi to Mihon (Tachiyomi): To sync Mihon (Tachiyomi) with Suwayomi, you have to open the manga's track information, then, Mihon (Tachiyomi) will automatically update its chapter list with the state from Suwayomi - Suwayomi to Mihon (Tachiyomi): To sync Mihon (Tachiyomi) with Suwayomi, you have to open the manga's track information, then, Mihon (Tachiyomi) will automatically update its chapter list with the state from Suwayomi
### The Suwayomi merge source in Neko
- You can enable the `Suwayomi` source in the Merge Source settings
- You can merge titles in Neko with titles from your Suwayomi library.
- You can enable 2-way automatic sync to track reading progress with your Suwayomi server.
- Note: only applies to merged titles
- Neko automatically updates the chapters read status in Suwayomi
- During updates, Neko will automatically update its chapter list with the read state from Suwayomi
- This only pulls if the status is read, to prevent marking read chapters as unread in Neko
### Other methods ### Other methods
Checkout [this issue](https://github.com/Suwayomi/Suwayomi-Server/issues/159) for tracking progress. Checkout [this issue](https://github.com/Suwayomi/Suwayomi-Server/issues/159) for tracking progress.