From 00aa3e94dcbd368b88e3a68620de018b3e211794 Mon Sep 17 00:00:00 2001 From: Legonzaur <34353603+Legonzaur@users.noreply.github.com> Date: Tue, 4 Apr 2023 19:04:25 +0200 Subject: [PATCH 1/2] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a47bee8..9c9ab23 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,6 @@ The serverside and clientside parts are two different executables. You may need # Documentation **DISCLAIMER: DOCUMENTATION ISNT UP TO DATE. WILL UPDATE SOON** -An OpenAPI file is located in `reference/OpenAPI.yml` +An OpenAPI file is located in `docs` directory -Alternatively, you can find it converted to markdown at [https://legonzaur.github.io/ToneAPI_backend/openapi](https://legonzaur.github.io/ToneAPI_backend/openapi) +Alternatively, you can find it converted at https://toneapi.github.io/ToneAPI_backend/ From acff144d2447b8fa84984037f5ca3d18c3d7b077 Mon Sep 17 00:00:00 2001 From: okvdai <108829133+okvdai@users.noreply.github.com> Date: Wed, 5 Apr 2023 14:00:26 +0200 Subject: [PATCH 2/2] fix README.md remove disclaimer about documentation not being up to date --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9c9ab23..333cd1d 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,14 @@ This is the backend for Tone API. -To install the Northstar mod, go [here](https://github.com/Legonzaur/ToneAPI_servermod) +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 parts are two different executables. You may need a reverse proxy like [nginx](https://www.nginx.com/) or use two different ports. # Documentation -**DISCLAIMER: DOCUMENTATION ISNT UP TO DATE. WILL UPDATE SOON** -An OpenAPI file is located in `docs` directory +An OpenAPI file is located in `docs` directory. Alternatively, you can find it converted at https://toneapi.github.io/ToneAPI_backend/