Update README.md

This commit is contained in:
mProjectsCode 2022-05-12 21:30:17 +02:00
parent d2afe3bcc2
commit 5a5abdd4a8

View file

@ -1,3 +1,60 @@
## Obsidian Media DB Plugin
This plugin can query multiple APIs for movies, series, anime, etc. and creates notes containing their information.
This plugin can query multiple APIs for movies, series, anime and games, and creates notes containing their information.
### Features
#### Search by Title
Search by the Name of the movie, series, anime or game.
#### Search by ID
Allows you to search by an ID that varies from API to API. Concrete info can be found in the description of the individual APIs.
### Currently supported APIs:
- [Jikan](https://jikan.moe/), an API that uses [My Anime List](https://myanimelist.net)
- supported formats
- series
- movies
- specials
- OVAs
- authentication
- no authentication needed
- SFW filter support
- yes
- Search by ID
- the ID you need is the ID of the anime on [My Anime List](https://myanimelist.net)
- you can find this ID in the URL
- e.g. for "Beyond the Boundary" the URL looks like this `https://myanimelist.net/anime/18153/Kyoukai_no_Kanata` so the ID is `18153`
- notes
- the api is very slow sometimes, this is normal
- the titles have to be with the titles that they have on [My Anime List](https://myanimelist.net), which are in most cases the japanese titles
- e.g. instead of "Demon Slayer" you have to search "Kimetsu no Yaiba"
- the API is rate limited to
- 60 requests per minute
- 3 requests per second
- [OMDb](https://www.omdbapi.com/)
- supported formats
- series
- movies
- games
- authentication
- an API key is needed
- you can get one for free [here](https://www.omdbapi.com/apikey.aspx)
- SFW filter support
- no, but I haven't encountered ant NSFW content in testing
- Search by ID
- the ID you need is the ID of the movie or show on [IMDb](https://www.imdb.com)
- you can find this ID in the URL
- e.g. for "Rogue One" the URL looks like this `https://www.imdb.com/title/tt3748528/` so the ID is `tt3748528`
- notes
- the api is rate limited to 1000 requests a day
### Currently supported media types
- movies (including specials)
- series (including OVAs)
- games
### Contributions
Thank you for wanting to contribute to this project.
Contributions are always welcome. If you have an idea, feel free to open a feature request under the issue tab or even create a pull request.