From ce971726a355a6ce3dfea23d4de88d0b8d3c3170 Mon Sep 17 00:00:00 2001 From: "Kalle (Sendou)" <38327916+Sendouc@users.noreply.github.com> Date: Mon, 8 Mar 2021 01:48:26 +0200 Subject: [PATCH] update api section on readme --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 088160db9..0a600c898 100644 --- a/README.md +++ b/README.md @@ -85,9 +85,11 @@ e) On the "OAuth2" tab add `http://localhost:3000/api/auth/callback/discord` in ## Using API -If you wish to use the sendou.ink API for your own project like a Discord bot you can use the API endpoints under `https://sendou.ink/api/bot` (https://github.com/Sendouc/sendou.ink/tree/main/pages/api/bot) as long as you keep the load on my backend reasonable. +If you wish to use the sendou.ink API for your own project you can refer to the API endpoints here: https://github.com/Sendouc/sendou.ink/tree/main/pages/api -Using other endpoints isn't advised as I change those as I feel to suit the needs of the website. If the endpoints under `/bot` don't meet your use case feel free to leave an issue. +However it should be noted I develop the API for my own purposes and due to that there is always a possibility that the endpoints will change or be removed without a warning. + +If you end up using them I'm just asking you keep the load reasonable (use caching if your project is even a bit busy). ## Contributing