diff --git a/README.md b/README.md index 90f71c0..0d37e6f 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/) 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 `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/