From 1d09d445af7b50cb3aaa68d1123486251cb852db Mon Sep 17 00:00:00 2001
From: Bastien Riviere <me@babariviere.com>
Date: Mon, 29 Jan 2024 22:25:40 +0100
Subject: [PATCH] docs: improve readme

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index db6d54d..e4f82db 100644
--- a/README.md
+++ b/README.md
@@ -26,3 +26,20 @@ docker compose up -d
 just migrate # or atlas migrate apply --env local
 go run .
 ```
+
+## Accessing the docs
+
+The docs is using the `openapi.yaml` provided in the root directory. A web UI is available at http://localhost:8080/docs.
+It's using Rapidoc under the hood.
+
+## Testing
+
+You can simply test using:
+
+```sh
+# ensure postgres is up
+docker compose up -d
+go test ./...
+```
+
+It will create database on the fly for each test.