pokeapi-api-data/README.md

24 lines
720 B
Markdown
Raw Normal View History

# PokeAPI Data
2018-09-15 10:34:03 +02:00
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
2018-09-15 10:54:58 +02:00
- [updater](updater): a [Ditto][1] based bot that runs in docker and can update the data stored in this repo
2018-09-15 10:51:34 +02:00
# Usage
2018-09-15 10:54:58 +02:00
If you'd like to use the JSON for your own purposes, you can apply your own base URL using [Ditto][1]:
2018-09-15 10:51:34 +02:00
```
ditto transform --base-url='https://pokeapi.co'
```
2018-09-15 10:34:03 +02:00
# Updater Bot
2018-09-15 10:34:03 +02:00
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.
2018-09-15 10:54:58 +02:00
[1]: https://github.com/pokeapi/ditto