Skip to content

Commit 23d1a41

Browse files
authored
docs: add image/refactor README (#23)
1 parent 968e6fa commit 23d1a41

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
1-
[![CircleCI](https://circleci.com/gh/PokeAPI/api-data.svg?style=shield)](https://circleci.com/gh/PokeAPI/api-data)
1+
# PokéAPI data <img src='https://veekun.com/dex/media/pokemon/global-link/480.png' height=50px/>
22

3-
# PokeAPI Data
3+
[![CircleCI](https://circleci.com/gh/PokeAPI/api-data.svg?style=shield)](https://circleci.com/gh/PokeAPI/api-data)
44

55
This repository contains:
66

7-
- [data/api](data/api): a static copy of the JSON data generated with the above script
8-
- [data/schema](data/schema): a static copy of the PokeAPI schema generated from the above data
9-
- [updater](updater): a [Ditto][1] based bot that runs in docker and can update the data stored in this repo
7+
- [data/api](data/api): a static copy of the JSON data generated with the above script
8+
- [data/schema](data/schema): a static copy of the PokeAPI schema generated from the above data
9+
- [updater](updater): a [Ditto][1] based bot that runs in docker and can update the data stored in this repo
1010

11-
# Usage
11+
## Usage
1212

1313
If you'd like to use the JSON for your own purposes, you can apply your own base URL using [Ditto][1]:
1414

15-
```
15+
```sh
1616
ditto transform --base-url='https://pokeapi.co'
1717
```
1818

19-
# Updater Bot
19+
## Updater bot
2020

2121
You can manually update the data if necessary. See [the updater bot](updater).
2222
You can run the bot in docker, or read and adapt its update script yourself.
2323

24-
2524
[1]: https://github.com/pokeapi/ditto

0 commit comments

Comments
 (0)