Mirrors/pokeapi-api-data
1
0
Fork 0
mirror of https://github.com/PokeAPI/api-data.git synced 2024-11-22 23:52:31 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Sargun Vohra 2018-09-15 01:54:58 -07:00 committed by GitHub
parent 878f275257
commit 6db6804a34
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -4,10 +4,10 @@ This repository contains:
- [data/api](data/api): a static copy of the JSON data generated with the above script
- [data/schema](data/schema): a static copy of the PokeAPI schema generated from the above data
- [updater](updater): a [Ditto](https://github.com/pokeapi/ditto) based bot that runs in docker
and can update the data stored in this repo
- [updater](updater): a [Ditto][1] based bot that runs in docker and can update the data stored in this repo
- Deployment configs to deploy an instance of the API to [Netlify][2]
If you'd like to use the JSON, you can apply your own base URL using [Ditto](https://github.com/pokeapi/ditto):
If you'd like to use the JSON for your own purposes, you can apply your own base URL using [Ditto][1]:
```
ditto transform --base-url='https://pokeapi.co'
@ -15,3 +15,7 @@ ditto transform --base-url='https://pokeapi.co'
You can manually update the data if necessary. See [the updater bot](updater).
You can run the bot in docker, or read and adapt its update script yourself.
[1]: https://github.com/pokeapi/ditto
[2]: https://www.netlify.com/