Leahnaya/sendou.ink
1
0
Fork 0
mirror of https://github.com/Sendouc/sendou.ink.git synced 2026-09-11 05:36:10 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

update api section on readme

Browse Source
This commit is contained in:
Kalle (Sendou)
2021-03-08 01:48:26 +02:00
parent 3ff11f6cc5
commit ce971726a3
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

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