mirror of
https://github.com/jikan-me/jikan-rest.git
synced 2025-02-20 11:23:35 +08:00
update readme
This commit is contained in:
parent
8d49e8bd26
commit
4a61510cf6
18
README.MD
Normal file
18
README.MD
Normal file
@ -0,0 +1,18 @@
|
||||
# Jikan REST API Source
|
||||
|
||||
This REST API is built on Lumen and is in development, therefore neither will I product or help for any in-depth installation/set up guides at the moment for an instance.
|
||||
|
||||
|
||||
## What this requires
|
||||
- Composer
|
||||
- Lumen
|
||||
- BugSnag
|
||||
- JikanPHP Library (just composer update)
|
||||
- Redis
|
||||
|
||||
## Quick set up
|
||||
1. Install Lumen
|
||||
2. Overwrite with this
|
||||
3. `composer update`
|
||||
4. Make a BugSnag Account & set the details in `.env`
|
||||
5. Set up Redis & enter the connection credentials in `.env`
|
Loading…
x
Reference in New Issue
Block a user