update README

This commit is contained in:
askiiart 2024-11-27 10:38:12 -06:00
parent 12e3ca8402
commit de4c12b0a1
Signed by untrusted user who does not match committer: askiiart
GPG key ID: EA85979611654C30

View file

@ -1,17 +1,17 @@
# Torznab Toolkit
A toolkit for adding Torznab APIs to programs.
A safe, multi-threaded toolkit for adding Torznab APIs to programs.
## Functionality
| API call | Explanation | Compatibility |
| -------- | ------------------------------------------------------------ | -------------- |
| caps | Returns the capabilities of the api. | ❌ |
| search | Free text search query. | ❌ |
| tvsearch | Search query with tv specific query params and filtering. | ❌ |
| movie | Search query with movie specific query params and filtering. | ❌ |
| music | Search query with music specific query params and filtering. | ❌ |
| book | Search query with book specific query params and filtering. | ❌ |
| API call | Explanation | Implemented |
| -------- | ------------------------------------------------------------ | ----------- |
| caps | Returns the capabilities of the api. | ❌ |
| search | Free text search query. | ❌ |
| tvsearch | Search query with tv specific query params and filtering. | ❌ |
| movie | Search query with movie specific query params and filtering. | ❌ |
| music | Search query with music specific query params and filtering. | ❌ |
| book | Search query with book specific query params and filtering. | ❌ |
<!-- for copy-pasting: ❌ ✅ -->
(copied from [torznab.github.io](https://torznab.github.io/spec-1.3-draft/torznab/Specification-v1.3.html))