Skip to content

Commit b2a9ade

Browse files
committed
docs: Update README.md to improve feature descriptions and organization
1 parent d6cd78c commit b2a9ade

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,20 @@ AniBridge is a minimal FastAPI service that bridges anime streaming services (cu
1616
- **qBittorrent API shim** allowing Prowlarr/Sonarr to enqueue downloads.
1717
- **Background scheduler** with progress tracking for downloads.
1818
- Simple `/health` endpoint for container or orchestration checks.
19+
- Docker Image for easy deployment
20+
21+
## Currently work-in-progress / TODO
22+
23+
- Better code structure and organization (refactoring, modularization, right now the code is a bit messy with comments in multiple languages, redundant code, etc. 😅)
24+
- Converting absolute episode numbers to relative ones (e.g., "001" to "S01E01"). If the series type is set to "Anime/Absolute", AniBridge currently will not find any episodes. This is because of the way AniWorld numbers episodes.
25+
- Documentation, configuration instructions, and examples...
1926

2027
## Planned Features
2128

2229
- Support for non anime sites like s.to
2330
- Interactive user search via Prowlarr (currently only search via Sonarr/API possible)
2431
- Full support for RSS Sync
25-
- Documentation, configuration instructions, and examples...
26-
- Docker Image for easy deployment
27-
- Better code structure and organization (refactoring, modularization, right now the code is a bit messy with comments in multiple languages, redundant code, etc. 😅)
32+
- Toggleable WebUI
2833

2934
## Installation
3035

0 commit comments

Comments
 (0)