From 0a64d58631121f0377a6ea88bfb1ee34eb620aa1 Mon Sep 17 00:00:00 2001 From: Zoe Roux Date: Sun, 22 Mar 2026 20:27:01 +0100 Subject: [PATCH] Update readme (#1389) --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 375ff71f..560e8d35 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Kyoo does not have a plugin system and aim to have every features built-in (see - **[Installation](./INSTALLING.md):** Basic installation guidelines, how to start Kyoo, enable OIDC or hardware transcoding. - **[Join the discord](https://discord.gg/E6Apw3aFaA):** Ask questions, talk about the development, feature you might want or bugs you might encounter. -- **[API Documentation](https://kyoo.zoriya.dev/api/doc):** The API to integrate Kyoo with other services, if you have any questions, please ask on GitHub or Discord! +- **[API Documentation](https://kyoo.zoriya.dev/swagger):** The API to integrate Kyoo with other services, if you have any questions, please ask on GitHub or Discord! - **[Contributing](./CONTRIBUTING.md):** Feel free to open issues, submit pull requests, and contribute to making Kyoo even better. We need you! [![](https://discord.com/api/guilds/1216460898139635753/widget.png?style=banner2)](https://discord.gg/zpA74Qpvj5) @@ -24,23 +24,21 @@ Kyoo does not have a plugin system and aim to have every features built-in (see - **Video Preview Thumbnails:** Simply hover the video's progress bar and see a preview of the video. -- **Meilisearch-Powered Search:** Advanced, typo-resilient search system powered by Meilisearch. +- **Enhanced Subtitle Support:** Subtitles are important, Kyoo supports PGS/VODSUB and SSA/ASS and uses the video's embedded fonts when available. -- **OIDC Connection:** Connect using any OIDC compliant service (Google, Discord, Authelia, you name it). - -- **Watch List Scrubbing Support:** Your watch list is automatically synced to connected services (SIMKL and soon others [#351](https://github.com/zoriya/Kyoo/issues/351), [#352](https://github.com/zoriya/Kyoo/issues/352)). No need to manually mark episodes as watched. - -- **Download and Offline Support:** Download videos to watch them without internet access, your progress will automatically be synced next time your devices goes online. - -- **Enhanced Subtitle Support:** Subtitles are important, Kyoo supports SSA/ASS and uses the video's embedded fonts when available. - -- **Anime Name Parsing**: While there are still some issues (see [#466](https://github.com/zoriya/Kyoo/issues/466), Kyoo will match weird anime names (like `[Some-Stuffs] Jojo's Bizarre Adventure Stone Ocean 24 (1920x1080 Blu-Ray Opus) [2750810F].mkv`) without issue. +- **Anime Name Parsing**: Kyoo will match weird anime names (like `[Some-Stuffs] Jojo's Bizarre Adventure Stone Ocean 24 (1920x1080 Blu-Ray Opus) [2750810F].mkv`) without issue. - **Helm Chart:** Deploy Kyoo to your Kubernetes cluster today! There is an official Helm chart. Multiple replicas is a WIP! +- ~**OIDC Connection:** Connect using any OIDC compliant service (Google, Discord, Authelia, you name it).~ (soon, not reimplemented in v5 yet) + +- ~**Watch List Scrubbing Support:** Your watch list is automatically synced to connected services (SIMKL and soon others [#351](https://github.com/zoriya/Kyoo/issues/351), [#352](https://github.com/zoriya/Kyoo/issues/352)). No need to manually mark episodes as watched.~ (soon, not reimplemented in v5 yet) + +- ~**Download and Offline Support:** Download videos to watch them without internet access, your progress will automatically be synced next time your devices goes online.~ (soon, not reimplemented in v5 yet) + ## 📺 Clients -Kyoo currently supports Web and Android clients, with additional platforms being thought about. +Kyoo currently supports Web and ~Android clients~ (soon, not yet in v5), with additional platforms being thought about. Don't see your client? Kyoo is focused on adding features, but welcomes contributors! The frontend is built with React-Native and Expo. Come hang and develop with us on Discord.