shadowfacts
/
fervor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
An open standard for self-hosted RSS aggregator APIs.
6 Commits 1 Branch 0 Tags 50 KiB
Markdown 100%
Go to file
Shadowfacts 79e7d84ce2
Clarify read/unread responses 		2019-03-31 10:45:06 -04:00
.gitignore Initial commit 2019-03-27 10:18:52 -04:00
README.md Initial commit 2019-03-27 10:18:52 -04:00
authentication.md Add no redirect for authentication 2019-03-28 14:13:24 -04:00
endpoints.md Clarify read/unread responses 2019-03-31 10:45:06 -04:00
entities.md Add Group service_url 2019-03-28 19:07:00 -04:00
extensions.md Additional management endpoints 2019-03-28 11:05:25 -04:00
pagination.md Initial commit 2019-03-27 10:18:52 -04:00

README.md

Fervor API

Fervor is a open standard for a self-hosted RSS aggregator API. It's primary goal is to replace the current de-facto standard, the Fever API.

The Fever API has a number of issues, including:

  1. Using MD5 for authentication.
  2. Poor design (e.g. group and feeds_group being separate entities.)
  3. Poor documentation (the difference between group and feeds_group is never articulated.)
  4. No longer being maintained.

The Fervor API is intended to be a common foundation for self-hosted RSS aggregators, not a catch-all solution. Different services will have their own specific needs from an API, so Fervor is designed to be only the component that is common to all of RSS aggregator implementations.

Specification

The specification is divided into the following sections:

Versioning

The Fervor API uses Semantic Versioning.

Minor fixes increment the patch number, minor additions increment the minor number, and any removals increment the major number.

The current Fervor version is 0.1.0. The major version 0 will remain until the specification is finished and no longer a draft.

Known Implementations

Clients

Servers