From 304109de946c0477f3874dc8a73d2cac2514f2af Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gerg=C5=91=20Jedlicska?= <gergo@jedlicska.com>
Date: Mon, 12 Feb 2024 10:44:54 +0100
Subject: [PATCH] docs: add project setup documentation

---
 README.md | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 932eb1b..b2e7a55 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,22 @@
-# about postgres
+# Multi tenancy sketches
 
-i had to change the `wal_level` on my local postgres instances
-done with 
-```
+This project is a synthetic test project for implementing multi tenancy.
+Its a functional graphql api backend, that is easiest to access from the apollo graphql explorer.
+The api and the explorer are available by default at `http://localhost:4000` by default,
+after the app and its dependencies have been started
+
+## Project setup
+
+This project is using [`pnpm`](https://pnpm.io/) as its package manager.
+To start the required databases or other dependencies, run `docker compose up -d`
+
+## about Postgres setup
+
+I had to change the `wal_level` on my local postgres instances
+it is done with running the SQL command below, and restating the database server:
+
+```sql
 ALTER SYSTEM SET wal_level = logical;
-```
\ No newline at end of file
+```
+
+## Using the api