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

docs: add image/refactor README (#23)

Browse Source
This commit is contained in:
Alessandro Pezzè 2019-12-28 20:59:30 +01:00 committed by GitHub
parent 968e6fa6c3
commit 23d1a41c01
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,25 +1,24 @@
[![CircleCI](https://circleci.com/gh/PokeAPI/api-data.svg?style=shield)](https://circleci.com/gh/PokeAPI/api-data) # PokéAPI data <img src='https://veekun.com/dex/media/pokemon/global-link/480.png' height=50px/>
# PokeAPI Data [![CircleCI](https://circleci.com/gh/PokeAPI/api-data.svg?style=shield)](https://circleci.com/gh/PokeAPI/api-data)
This repository contains: This repository contains:
- [data/api](data/api): a static copy of the JSON data generated with the above script - [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 - [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 - [updater](updater): a [Ditto][1] based bot that runs in docker and can update the data stored in this repo
# Usage ## Usage
If you'd like to use the JSON for your own purposes, you can apply your own base URL using [Ditto][1]: If you'd like to use the JSON for your own purposes, you can apply your own base URL using [Ditto][1]:
``` ```sh
ditto transform --base-url='https://pokeapi.co' ditto transform --base-url='https://pokeapi.co'
``` ```
# Updater Bot ## Updater bot
You can manually update the data if necessary. See [the updater bot](updater). 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. You can run the bot in docker, or read and adapt its update script yourself.
[1]: https://github.com/pokeapi/ditto [1]: https://github.com/pokeapi/ditto