mirror of
https://github.com/gabehf/sonarr-anime-importer.git
synced 2026-03-19 03:56:25 -07:00
update README
This commit is contained in:
parent
2f7910e117
commit
4a63c33681
1 changed files with 19 additions and 1 deletions
18
README.md
18
README.md
|
|
@ -8,3 +8,21 @@ Pulls MyAnimeList and TVDB ID associations from https://raw.githubusercontent.co
|
||||||
## Supported Requests
|
## Supported Requests
|
||||||
### GET /anime
|
### GET /anime
|
||||||
See https://docs.api.jikan.moe/#tag/anime/operation/getAnimeSearch for parameters.
|
See https://docs.api.jikan.moe/#tag/anime/operation/getAnimeSearch for parameters.
|
||||||
|
|
||||||
|
Example request:
|
||||||
|
```bash
|
||||||
|
# fetches the top 10 most popular currently airing tv anime
|
||||||
|
curl "http://localhost:3333/anime?type=tv&status=airing&order_by=popularity&sort=asc&limit=10"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Docker Compose
|
||||||
|
```yaml
|
||||||
|
services:
|
||||||
|
sonarr-mal-importer:
|
||||||
|
image: gabehf/sonarr-mal-importer:latest
|
||||||
|
container_name: sonarr-mal-importer
|
||||||
|
ports:
|
||||||
|
- 3333:3333
|
||||||
|
restart: unless-stopped
|
||||||
|
|
||||||
|
```
|
||||||
Loading…
Add table
Add a link
Reference in a new issue