Skip to content

Commit 9f49587

Browse files
authored
[skip ci] Update readme (#1008)
* Move JUI and Sorayomi to inactive clients * Update client descriptions * Remove outdated mihon sync info * Update feature list * Move Docker installation info to top of list * Move feature list higher in readme * Rename feature list section to "Features" * Separate inactive/abonded clients
1 parent b7b733f commit 9f49587

File tree

1 file changed

+30
-23
lines changed

1 file changed

+30
-23
lines changed

Diff for: README.md

+30-23
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
## Table of Content
77
- [What is Suwayomi?](#what-is-suwayomi)
8+
- [Features](#Features)
89
- [Suwayomi client projects](#Suwayomi-client-projects)
9-
* [Is this application usable? Should I test it?](#is-this-application-usable-should-i-test-it)
1010
- [Downloading and Running the app](#downloading-and-running-the-app)
1111
* [Using Operating System Specific Bundles](#using-operating-system-specific-bundles)
1212
- [Launcher Scripts](#launcher-scripts)
@@ -36,35 +36,42 @@ Suwayomi is an independent Mihon (Tachiyomi) compatible software and is **not a
3636

3737
Suwayomi-Server is as multi-platform as you can get. Any platform that runs java and/or has a modern browser can run it. This includes Windows, Linux, macOS, chrome OS, etc. Follow [Downloading and Running the app](#downloading-and-running-the-app) for installation instructions.
3838

39-
Ability to sync with Mihon (Tachiyomi) is a planned feature, for more info look [here](#syncing-with-mihon-tachiyomi).
39+
You can use Mihon (Tachiyomi) to access your Suwayomi-Server. For more info look [here](#syncing-with-mihon-tachiyomi).
40+
41+
## Features
42+
> [!NOTE]
43+
>
44+
> These are capabilities of Suwayomi-Server, the actual working support is provided by each front-end app, checkout their respective readme for more info.
45+
46+
- Installing and executing Mihon (Tachiyomi)'s Extensions, So you'll get the same sources
47+
- Searching and browsing installed sources
48+
- A library to save your mangas and categories to put them into
49+
- Automated library updates to check for new chapters
50+
- Automated download of new chapters
51+
- Viewing latest updated chapters
52+
- Ability to download Manga for offline read
53+
- Backup and restore support powered by Mihon (Tachiyomi)-compatible Backups
54+
- Automated backup creations
55+
- Tracking via [MyAnimeList](https://myanimelist.net/), [AniList](https://anilist.co/), [MangaUpdates](https://www.mangaupdates.com/)
56+
- [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr) support to bypass Cloudflare protection
57+
- Automated WebUI updates (supports the default WebUI and VUI)
4058

4159
# Suwayomi client projects
4260
**You need a client/user interface app as a front-end for Suwayomi-Server, if you [Directly Download Suwayomi-Server](https://github.com/Suwayomi/Suwayomi-Server/releases/latest) you'll get a bundled version of [Suwayomi-WebUI](https://github.com/Suwayomi/Suwayomi-WebUI) with it.**
4361

44-
Here's a list of known clients/user interfaces for Suwayomi-Server:
62+
Here's a list of known clients/user interfaces for Suwayomi-Server (checkout the respective GitHub repository for their features):
4563
##### Actively Developed Clients
46-
- [Suwayomi-WebUI](https://github.com/Suwayomi/Suwayomi-WebUI): The web/ElectronJS front-end that Suwayomi-Server ships with by default.
47-
- [Tachidesk-JUI](https://github.com/Suwayomi/Tachidesk-JUI): The native desktop front-end for Suwayomi-Server. Currently, the most advanced.
48-
- [Tachidesk-Sorayomi](https://github.com/Suwayomi/Tachidesk-Sorayomi): A Flutter front-end for Desktop(Linux, windows, etc.), Web and Android with a User Interface inspired by Mihon (Tachiyomi).
64+
- [Suwayomi-WebUI](https://github.com/Suwayomi/Suwayomi-WebUI): The web front-end that Suwayomi-Server ships with by default.
65+
- [Suwayomi-VUI](https://github.com/Suwayomi/Suwayomi-VUI): A Suwayomi-Server preview focused web frontend built with svelte
4966
- [Tachidesk-VaadinUI](https://github.com/Suwayomi/Tachidesk-VaadinUI): A Web front-end for Suwayomi-Server built with Vaadin.
50-
- [Suwayomi-VUI](https://github.com/Suwayomi/Suwayomi-VUI): A preview focused web frontend built with svelte with some features the other UIs might not have (migration)
51-
##### Inactive/Abandoned Clients
67+
##### Inactive Clients (functional but outdated)
68+
- [Tachidesk-JUI](https://github.com/Suwayomi/Tachidesk-JUI): The native desktop front-end for Suwayomi-Server.
69+
- [Tachidesk-Sorayomi](https://github.com/Suwayomi/Tachidesk-Sorayomi): A Flutter front-end for Desktop(Linux, windows, etc.), Web and Android with a User Interface inspired by Mihon (Tachiyomi).
70+
##### Abandoned Clients (functionality unknown)
5271
- [Tachidesk-qtui](https://github.com/Suwayomi/Tachidesk-qtui): A C++/Qt front-end for mobile devices(Android/linux), feature support is basic.
5372
- [Tachidesk-GTK](https://github.com/mahor1221/Tachidesk-GTK): A native Rust/GTK desktop client.
5473
- [Equinox](https://github.com/Suwayomi/Equinox): A web user interface made with Vue.js.
5574

56-
## Is this application usable? Should I test it?
57-
Here is a list of current features:
58-
59-
- Installing and executing Mihon (Tachiyomi)'s Extensions, So you'll get the same sources
60-
- A library to save your mangas and categories to put them into
61-
- Searching and browsing installed sources
62-
- Ability to download Manga for offline read
63-
- Backup and restore support powered by Mihon (Tachiyomi)-compatible Backups
64-
- Viewing latest updated chapters.
65-
66-
**Note:** These are capabilities of Suwayomi-Server, the actual working support is provided by each front-end app, checkout their respective readme for more info.
67-
6875
# Downloading and Running the app
6976
## Using Operating System Specific Bundles
7077
To facilitate the use of Suwayomi we provide bundle releases that include The Java Runtime Environment, ElectronJS and the Suwayomi-Launcher.
@@ -87,6 +94,9 @@ Download the latest `linux-x64`(x86_64) release from [the releases section](http
8794
`tar xvf` the downloaded file and double-click on one of the launcher scripts or run them using the terminal.
8895

8996
## Other methods of getting Suwayomi
97+
### Docker
98+
Check our Official Docker release [Suwayomi Container](https://github.com/orgs/Suwayomi/packages/container/package/tachidesk) for running Suwayomi Server in a docker container. Source code for our container is available at [docker-tachidesk](https://github.com/Suwayomi/docker-tachidesk), an example compose file can also be found there. By default, the server will be running on http://localhost:4567 open this url in your browser.
99+
90100
### Arch Linux
91101
You can install Suwayomi from the AUR:
92102
```
@@ -123,9 +133,6 @@ For more information, see [the NixOS manual](https://nixos.org/manual/nixos/stab
123133

124134
You can also directly use the package from [nixpkgs](https://search.nixos.org/packages?channel=unstable&type=packages&query=suwayomi-server).
125135

126-
### Docker
127-
Check our Official Docker release [Suwayomi Container](https://github.com/orgs/Suwayomi/packages/container/package/tachidesk) for running Suwayomi Server in a docker container. Source code for our container is available at [docker-tachidesk](https://github.com/Suwayomi/docker-tachidesk), an example compose file can also be found there. By default, the server will be running on http://localhost:4567 open this url in your browser.
128-
129136
## Advanced Methods
130137
### Running the jar release directly
131138
In order to run the app you need the following:

0 commit comments

Comments
 (0)