From 7ccef809047730c3de9b9b3dadb2e00f973c04db Mon Sep 17 00:00:00 2001
From: xbgmsharp <xbgmsharp@gmail.com>
Date: Tue, 23 Apr 2024 16:35:12 +0200
Subject: [PATCH] Update README

---
 README.md      |  6 +++---
 docs/README.md | 25 ++++++++++++++++++++++---
 2 files changed, 25 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 9b0dc35..7ae44d4 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@
     PostgSail is an open-source alternative to traditional vessel data management!
     <br/>
     <br/>
-    <a href="https://github.com/xbgmsharp/postgsail/docs/"><strong>Explore the docs »</strong></a>
+    <a href="https://github.com/xbgmsharp/postgsail/blob/main/docs/README.md"><strong>Explore the docs »</strong></a>
     <br/>
     <br/>
     <a href="https://iot.openplotter.cloud/demo">View Demo</a>
@@ -68,7 +68,7 @@ It is all about SQL, object-relational, time-series, spatial databases with a bi
 PostgSail is an open-source alternative to traditional vessel data management.
 It is based on a well known open-source technology stack, Signalk, PostgreSQL, TimescaleDB, PostGIS, PostgREST. It does perfectly integrate with standard monitoring tool stack like Grafana.
 
-To understand the why and how, you might want to read [Why.md](https://github.com/xbgmsharp/postgsail/tree/main/Why.md)
+To understand the why and how, you might want to read [Why.md](https://github.com/xbgmsharp/postgsail/blob/main/Why.md)
 
 ## Cloud-hosted PostgSail
 
@@ -102,7 +102,7 @@ Contributions are what make the open source community such an amazing place to b
 
 ## License
 
-Distributed under the Apache License Version 2.0. See [LICENSE](https://github.com/xbgmsharp/postgsail/blob/main/LICENSE.md) for more information.
+Distributed under the Apache License Version 2.0. See [LICENSE](https://github.com/xbgmsharp/postgsail/blob/main/LICENSE) for more information.
 
 ## Acknowledgements
 
diff --git a/docs/README.md b/docs/README.md
index fb45b1c..5d99dfb 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -13,6 +13,7 @@ For more clarity and visibility the complete [Entity-Relationship Diagram (ERD)]
 
 A full-featured development environment.
 
+### Development
 #### With CodeSandbox
 
 - Develop on [![CodeSandbox Ready-to-Code](https://img.shields.io/badge/CodeSandbox-Ready--to--Code-blue?logo=codesandbox)](https://codesandbox.io/p/github/xbgmsharp/postgsail/main)
@@ -26,7 +27,9 @@ A full-featured development environment.
 #### With Docker Dev Environments
 - [Open in Docker dev-envs!](https://open.docker.com/dashboard/dev-envs?url=https://github.com/xbgmsharp/postgsail/)
 
-### pre-deploy configuration
+
+### On-premise (self-hosted)
+#### pre-deploy configuration
 
 To get these running, copy `.env.example` and rename to `.env` then set the value accordingly.
 
@@ -34,12 +37,26 @@ To get these running, copy `.env.example` and rename to `.env` then set the valu
 # cp .env.example .env
 ```
 
+```bash
+# nano .env
+```
+
 Notice, that `PGRST_JWT_SECRET` must be at least 32 characters long.
 
 `$ cat /dev/urandom | LC_ALL=C tr -dc 'a-zA-Z0-9' | fold -w 42 | head -n 1`
 
-```bash
-# nano .env
+`PGSAIL_APP_URL` is the url in you connect to in your browser.
+
+`PGSAIL_API_URL` is the URL where `PGSAIL_APP_URL` connect to.
+
+`PGRST_DB_URI` is the URI where the `PGSAIL_API_URL` connect to.
+
+To summarize:
+```mermaid
+graph LR
+    A[YOU] -- HTTP --> B{PGSAIL_APP_URL}
+    B -- HTTP --> C{PGSAIL_API_URL}
+    C -- SQL --> D{PGRST_DB_URI}
 ```
 
 ### Deploy
@@ -94,6 +111,8 @@ UPDATE app_settings
     WHERE name = 'app.email_server';
 ```
 
+As it is all about SQL, [Read more](https://github.com/xbgmsharp/postgsail/docs/ERD/README) about the database and explore your data.
+
 ### Ingest data
 
 Next, to ingest data from signalk, you need to install [signalk-postgsail](https://github.com/xbgmsharp/signalk-postgsail) plugin on your signalk server instance.