From 2f0c3effb48b2c0e135155405bb7bfe2069de646 Mon Sep 17 00:00:00 2001 From: legonzaur Date: Wed, 26 Apr 2023 16:58:03 +0200 Subject: [PATCH] update Readme --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 09698b2..1736729 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ -# fvnkhead.killstat +# What is Tone API? + +Tone is an API that allows everyone to view their ingame stats for Northstar. + +The following projects allows users to visualize the API data +|Client |Platform | | | | +|----------------------------------------------------------------------------|----------------------|---|---|---| +|[ToneAPI_webclient](https://github.com/ToneAPI/ToneAPI_webclient) |Webapp | | | | +|[Pulse](https://github.com/ToneAPI/pulse) |Northstar Client mod | | | | +|[Sonar](https://github.com/ToneAPI/Sonar) |Discord bot | | | | + +Documentation for the API can be found here : https://github.com/Legonzaur/ToneAPI_backend +# What is this mod ? +This mod is a serverside mod. + +When a player makes a kill, it sends the data to the API To use, you MUST set `Tone_token` -For now, DM @Legonzaur#2100 to get those informations - -Alternatively, you can selfhost your own backend [here](https://github.com/Legonzaur/ToneAPI_backend) +DM @Legonzaur#2100 to get a token \ No newline at end of file