Skip to content

Add image and refactor README #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Naramsim merged 1 commit into from
Dec 28, 2019
Merged

Add image and refactor README #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

- [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