malhuda/jikan-rest
1
0
Fork 0
mirror of https://github.com/jikan-me/jikan-rest.git synced 2025-02-20 11:23:35 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.MD

Browse Source
This commit is contained in:
Irfan 2021-04-11 23:05:40 +05:00
parent 96ce2502fe
commit 57b1023e67
1 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.MD
View File

@ -2,14 +2,14 @@
# Jikan - Unofficial MyAnimeList.net REST API
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/jikan-me/jikan-rest.svg)](http://isitmaintained.com/project/jikan-me/jikan-rest "Average time to resolve an issue") [![Percentage of issues still open](http://isitmaintained.com/badge/open/jikan-me/jikan-rest.svg)](http://isitmaintained.com/project/jikan-me/jikan-rest "Percentage of issues still open") [![stable](https://img.shields.io/badge/PHP-^7.2.5-blue.svg?style=flat)]() [![Discord Server](https://img.shields.io/discord/460491088004907029.svg?style=flat&logo=discord)](https://discordapp.com/invite/4tvCr36)
Jikan is a REST API for [MyAnimeList.net](https://myanimelist.net). It scrapes the website to satisfy the need for an API - which MyAnimeList lacks.
Jikan is a REST API for [MyAnimeList.net](https://myanimelist.net). It scrapes the website to satisfy the need for some API functionality - that MyAnimeList lacks.
The raison d'être of Jikan is to assist developers easily get the data they need for their apps and projects without having to depend on the lackluster official API, unstable APIs, or sidetracking their projects to develop parsers.
The raison d'être of Jikan is to assist developers easily get the data they need for their apps and projects without having to depend on unstable APIs, or sidetracking their projects to develop parsers.
The word _Jikan_ literally translates to _Time_ in Japanese (**時間**). And that's what this API saves you of. ;)
**Notice**: Jikan does not support authenticated requests. You can not update your lists.
**Notice**: Jikan does not support authenticated requests. You can not update your lists. Use the official MyAnimeList API for this.
## Index
- [Getting Started](#getting-started)
@ -34,16 +34,13 @@ The word _Jikan_ literally translates to _Time_ in Japanese (**時間**). And th
### Requirements
- PHP ^7.2.5
- PHP ^7.4
- [Composer](https://getcomposer.org/download/)
- [Redis](https://redis.io)
- [Supervisord](http://supervisord.org/) (optional)
- [MongoDB]()
#### 🐳 Docker
If you don't want to install it yourself, there are dockerized options available:
- [JikanREST Docker](https://github.com/fethica/jikan-rest-docker) by Fethi El Hassasna
- [JikanDocerized](https://github.com/zunjae/JikanDockerized) by Zunjae
### 01. Installation Prerequisites