From 50f8648f64d22b5b6910dcc456bd7c8c5ccdce73 Mon Sep 17 00:00:00 2001 From: icefed Date: Thu, 14 Sep 2023 20:14:29 +0800 Subject: [PATCH] update readme --- fever.md | 19 +++++++++++++++++++ readme.md | 21 ++------------------- 2 files changed, 21 insertions(+), 19 deletions(-) create mode 100644 fever.md diff --git a/fever.md b/fever.md new file mode 100644 index 0000000..b217943 --- /dev/null +++ b/fever.md @@ -0,0 +1,19 @@ +# Fever API support + +Fever API is a kind of RSS HTTP API interface, because the Fever API definition is not very clear, so the implementation of Fever server and Client may have some compatibility problems. + +The Fever API implemented by Yarr is based on the Fever API spec: https://github.com/DigitalDJ/tinytinyrss-fever-plugin/blob/master/fever-api.md. + +Here are some Apps that have been tested to work with yarr. Feel free to test other Clients/Apps and update the list here. + +> Different apps support different URL/Address formats. Please note whether the URL entered has `http://` scheme and `/` suffix. + +| App | Platforms | Config Server URL | +|:------------------------------------------------------------------------- | ---------------- |:--------------------------------------------------- | +| [Reeder](https://reederapp.com/) | MacOS
iOS | 127.0.0.1:7070/fever
http://127.0.0.1:7070/fever | +| [ReadKit](https://readkit.app/) | MacOS
iOS | http://127.0.0.1:7070/fever | +| [Fluent Reader](https://github.com/yang991178/fluent-reader) | MacOS
Windows | http://127.0.0.1:7070/fever/ | +| [Unread](https://apps.apple.com/us/app/unread-an-rss-reader/id1363637349) | iOS | http://127.0.0.1:7070/fever | +| [Fiery Feeds](https://voidstern.net/fiery-feeds) | MacOS
iOS | http://127.0.0.1:7070/fever | + +If you are having trouble using Fever, please open an issue and @icefed, thanks. diff --git a/readme.md b/readme.md index 7e204b1..f41595d 100644 --- a/readme.md +++ b/readme.md @@ -30,26 +30,9 @@ and run [the script](etc/install-linux.sh). For self-hosting, see `yarr -h` for auth, tls & server configuration flags. For building from source code, see [build.md](build.md) -## Fever API support +## Fever API -Fever API is a kind of RSS HTTP API interface, because the Fever API definition is not very clear, so the implementation of Fever server and Client may have some compatibility problems. - -The Fever API implemented by Yarr is based on the Fever API spec: https://github.com/DigitalDJ/tinytinyrss-fever-plugin/blob/master/fever-api.md. - -Here are some Apps that have been tested to work with yarr. Feel free to test other Clients/Apps and update the list here. - -> Different apps support different URL/Address formats. Please note whether the URL entered has `http://` scheme and `/` suffix. - -| App | Platforms | Config Server URL | -|:------------------------------------------------------------------------- | ---------------- |:--------------------------------------------------- | -| [Reeder](https://reederapp.com/) | MacOS
iOS | 127.0.0.1:7070/fever
http://127.0.0.1:7070/fever | -| [ReadKit](https://readkit.app/) | MacOS
iOS | http://127.0.0.1:7070/fever | -| [Fluent Reader](https://github.com/yang991178/fluent-reader) | MacOS
Windows | http://127.0.0.1:7070/fever/ | -| [Unread](https://apps.apple.com/us/app/unread-an-rss-reader/id1363637349) | iOS | http://127.0.0.1:7070/fever | -| [Fiery Feeds](https://voidstern.net/fiery-feeds) | MacOS
iOS | http://127.0.0.1:7070/fever | - - -If you are having trouble using Fever, please open an issue and @icefed, thanks. +Now, the Fever API is supported, see [Fever API support](fever.md). ## credits