update readme

This commit is contained in:
irfan-dahir 2018-04-21 13:28:44 +05:00
parent 8d49e8bd26
commit 4a61510cf6

18
README.MD Normal file
View 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`