From 0b8ca8b088a906968c91018a471f0e212be52845 Mon Sep 17 00:00:00 2001 From: karashiiro <49822414+karashiiro@users.noreply.github.com> Date: Tue, 3 Aug 2021 16:39:33 -0700 Subject: [PATCH] Write full documentation description --- src/Universalis.Application/doc_description.html | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/src/Universalis.Application/doc_description.html b/src/Universalis.Application/doc_description.html index 46cadfe0..f834f0fe 100644 --- a/src/Universalis.Application/doc_description.html +++ b/src/Universalis.Application/doc_description.html @@ -1,3 +1,13 @@ -There is a rate limit of 12 req/s (24 req/s burst) on the API, and 5 req/s (10 req/s burst) on the frontend. -To map item IDs to item names or vice versa, use XIVAPI. -To get a mapping of world IDs to world names, use this sheet. \ No newline at end of file +Welcome to the Universalis documentation page. +
+There is a rate limit of 12 req/s (24 req/s burst) on the API, and 5 req/s (10 req/s burst) on the website itself. +To map item IDs to item names or vice versa, use XIVAPI. +To get a mapping of world IDs to world names, use XIVAPI or +this sheet. +The key column represents the item ID, and the Name column represents the world name. +Note that not all listed worlds are available to be used — many of the worlds in this sheet are test worlds, +or Korean worlds (Korea is unsupported at this time). +
+If you use this API for your projects, please consider supporting the website's ever-increasing bandwidth costs on +Patreon, or making a one-time donation on +Ko-fi. \ No newline at end of file