diff --git a/readme.md b/readme.md index dbd3ad1..038a8c7 100644 --- a/readme.md +++ b/readme.md @@ -1,2 +1,33 @@ # XIV Character Cards +API to create fancy cards for FFXIV characters based on their Lodestone data, hosted at https://ffxiv-character-cards.herokuapp.com. + +## Endpoints + +### Getting images + +``https://ffxiv-character-cards.herokuapp.com/characters/id/.png`` +
Get the PNG for a character by its Lodestone ID. + +
+ +``https://ffxiv-character-cards.herokuapp.com/characters/name//.png`` +
Get the PNG for a character by its world and name. + +### Requesting images to be cached +If you are using this API together with an application that requires the API to respond very quickly, like Discord, you need to ask it to "prepare" the image for a character beforehand. + +``https://ffxiv-character-cards.herokuapp.com/prepare/id/`` +
Request a character image to be cached by its Lodestone ID. + +
+ +``https://ffxiv-character-cards.herokuapp.com/prepare/name//`` +
Request a character image to be cached by its world and name. + +The API will reply with its status, and in case of success, the URL to the final image. +``{"status":"ok","url":"/characters/id/123456789.png"}`` + +## Using in your application + +You can use the ``create-card.js`` file in any NodeJS project. It will return a PNG-buffer for you to use in your bot or application.
Check ``index.js`` for usage examples.