docs: updated readme and added changelog

main
Jef Roosens 2025-03-08 20:49:53 +01:00
parent 66349afdfc
commit f16cdfdfff
No known key found for this signature in database
GPG Key ID: 21FD3D77D56BAF49
2 changed files with 25 additions and 45 deletions

16
CHANGELOG.md 100644
View File

@ -0,0 +1,16 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased](https://git.rustybever.be/Chewing_Bever/otter)
### Added
* Implemented bare API features
* auth
* subscriptions
* episode changes
* devices

View File

@ -1,49 +1,13 @@
# Otter
## Todo list
Otter is a modern implementation of the [Gpodder server](https://gpodder.net/)
API. Its primary goal is to be used as a self-hostable drop-in replacement for
Gpodder, suitable for low-power devices.
The (initial) goal here is only to support JSON. Other formats *might* be added
on later, no guarantees.
## Features
* Authentication API
- [x] Login / Verify Login
- [x] Logout
* Directory API
- [ ] Retrieve Top Tags
- [ ] Retrieve Podcasts for Tag
- [ ] Retrieve Podcast Data
- [ ] Retrieve Episode Data
- [ ] Podcast Toplist
- [ ] Podcast Search
* Suggestions API
- [ ] Retrieve Suggested Podcasts
* Device API
- [x] Update Device Data
- [-] List Devices
- [ ] Get Device Updates
* Subscriptions API
- [ ] Get Subscriptions of Device
- [ ] Get All Subscriptions
- [ ] Upload Subscriptions of Device
- [ ] Upload Subscription Changes
- [ ] Get Subscription Changes
* Episode Actions API
- [ ] Episode Action Types
- [ ] Upload Episode Actions
- [ ] Get Episode Actions
* Podcast Lists API
- [ ] Create Podcast List
- [ ] Get Users Lists
- [ ] Get a Podcast List
- [ ] Update a Podcast List
- [ ] Delete a Podcast List
* Settings API
- [ ] Known Settings
- [ ] Save Settings
- [ ] Get Settings
* Favorites API
- [ ] Get Favorite Episodes
* Device Synchronization API
- [ ] Get Sync Status
- [ ] Start / Stop Sync
- [ ] Client Parametrization
* Implementation of API sections needed for synchronisation
* Authentication
* Devices API
* Subscriptions API
* Episode actions API