From fc6d7373982389bc96e7c30a7037023c6453769b Mon Sep 17 00:00:00 2001
From: syrell <syrell@syyrell.com>
Date: Thu, 31 Oct 2024 21:31:34 +0100
Subject: [PATCH] chore: Added more context in README

---
 README.adoc | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/README.adoc b/README.adoc
index 89c31ea..553a69e 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,3 +1,12 @@
 = Chirpy Server
 
-This repository holds my version of https://boot.dev[boot.dev] HTTP Servers course.
\ No newline at end of file
+This repository holds my version of https://boot.dev[boot.dev] HTTP Servers course. It consists in an API where users can log in and send messages (chirps).
+
+== Get started
+
+Chirpy relies on a Postgres database (the database should be created first). Needed environment variables are:
+
+* DB_URL: Postgres URL connection
+* PLATFORM: dev, on purpose of the course
+* JWT_SECRET: can be generated using `openssl rand -base64 64`
+* POLKA_KEY: predefined dummy API key used to illustrate webhook feature
\ No newline at end of file