From 23d1a41c01a00bc3c519c1125efed20eac3c864f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alessandro=20Pezz=C3=A8?= Date: Sat, 28 Dec 2019 20:59:30 +0100 Subject: [PATCH] docs: add image/refactor README (#23) --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index de4320c32..c4e974db4 100644 --- a/README.md +++ b/README.md @@ -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 -# PokeAPI Data +[![CircleCI](https://circleci.com/gh/PokeAPI/api-data.svg?style=shield)](https://circleci.com/gh/PokeAPI/api-data) 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][1] based bot that runs in docker and can update the data stored in this repo +- [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 -# Usage +## Usage 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' ``` -# Updater Bot +## Updater bot 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