update README

main
Gabe Farrell 7 months ago
parent 01eef81064
commit 80a1f250f7

@ -17,6 +17,7 @@ See https://docs.api.jikan.moe/#tag/anime/operation/getAnimeSearch for parameter
Additional parameters supported: Additional parameters supported:
- `allow_duplicates`: skips de-duplication of results - `allow_duplicates`: skips de-duplication of results
- `merge_seasons`: skips seasons of already included shows
Example request: Example request:
```bash ```bash
@ -48,6 +49,7 @@ Parameters:
- sort: [[MediaSort]](https://studio.apollographql.com/sandbox/schema/reference/enums/MediaSort) - sort: [[MediaSort]](https://studio.apollographql.com/sandbox/schema/reference/enums/MediaSort)
- limit: Int - limit: Int
- allowDuplicates: Boolean - allowDuplicates: Boolean
- mergeSeasons: Boolean
Example request: Example request:
```bash ```bash
@ -57,8 +59,7 @@ curl "http://localhost:3333/v1/anilist/anime?format=TV,ONA&sort=TRENDING_DESC&is
## Environment ## Environment
One configuration environment variable is supported: One configuration environment variable is supported:
- `ALWAYS_SKIP_MAL_IDS`: Comma-separated list of MyAnimeList IDs to always skip. These do not count towards the return limit. - `ALWAYS_SKIP_TVDB_IDS`: Comma-separated list of TVDB IDs to always skip. These do not count towards the return limit.
- `ALWAYS_SKIP_ANILIST_IDS`: Comma-separated list of AniList IDs to always skip. These do not count towards the return limit.
## Docker Compose ## Docker Compose
```yaml ```yaml
@ -69,8 +70,7 @@ services:
ports: ports:
- 3333:3333 - 3333:3333
environment: environment:
- ALWAYS_SKIP_MAL_IDS=12345,67890 # Comma-separated - ALWAYS_SKIP_TVDB_IDS=12345,67890 # Comma-separated
- ALWAYS_SKIP_ANILIST_IDS=01234,56789 # Comma-separated
restart: unless-stopped restart: unless-stopped
``` ```

Loading…
Cancel
Save