pokeapi-api-data/README.md

25 lines
919 B
Markdown
Raw Normal View History

2019-12-28 20:59:30 +01:00
# PokéAPI data <img src='https://veekun.com/dex/media/pokemon/global-link/480.png' height=50px/>
2018-09-29 05:19:19 +02:00
2019-12-28 20:59:30 +01:00
[![CircleCI](https://circleci.com/gh/PokeAPI/api-data.svg?style=shield)](https://circleci.com/gh/PokeAPI/api-data)
2018-09-15 10:34:03 +02:00
This repository contains:
2019-12-28 20:59:30 +01:00
- [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][1] based bot that runs in docker and can update the data stored in this repo
2018-09-15 10:51:34 +02:00
2019-12-28 20:59:30 +01: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
2019-12-28 20:59:30 +01:00
```sh
2018-09-15 10:51:34 +02:00
ditto transform --base-url='https://pokeapi.co'
```
2018-09-15 10:34:03 +02:00
2019-12-28 20:59:30 +01: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