From fcd1d7d1f0d7fadfb4499c9ccbb8273bf7792b05 Mon Sep 17 00:00:00 2001 From: legonzaur Date: Mon, 13 Mar 2023 20:55:58 +0100 Subject: [PATCH] Update README --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b8b97b..801533d 100644 --- a/README.md +++ b/README.md @@ -1 +1,9 @@ -# Stat_Tracker_Server \ No newline at end of file +# Stat_Tracker_Server + +This is the backend for Tone API. + +To install the Northstar mod, go [here](https://github.com/Legonzaur/ToneAPI_servermod) + +To install, you must have a [postgresql](https://www.postgresql.org/) and [redis](https://redis.io/) server. Rename the `.env.example` to `.env` and edit the values. + +The serverside and clientside part are two different executables. You may need a reverse proxy like [nginx](https://www.nginx.com/) or use two different ports.