From 5c2f2af20f645f17a7727ceaf4c93e6b69017d20 Mon Sep 17 00:00:00 2001 From: Legonzaur <34353603+Legonzaur@users.noreply.github.com> Date: Mon, 13 Mar 2023 20:57:23 +0100 Subject: [PATCH] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 801533d..fcdd511 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,9 @@ To install the Northstar mod, go [here](https://github.com/Legonzaur/ToneAPI_ser 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. + +# Documentation + +An OpenAPI file is located in `resources/OpenAPI.yml` + +Alternatively, you can find it converted to markdown at [https://legonzaur.github.io/ToneAPI_backend/openapi](https://legonzaur.github.io/ToneAPI_backend/openapi)