From e259808322d069b5f450fb229beef77228d102b3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Nielson=20Jann=C3=A9?= <nielsonj@gmail.com>
Date: Wed, 12 Mar 2025 14:46:02 +0100
Subject: [PATCH] Adds information to the readme

---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 286b12b..6ca699e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,31 @@
 # generic-RAG-demo
 
-A generic RAG demo
\ No newline at end of file
+A Sogeti Nederland generic RAG demo
+
+## Getting Started
+
+Please mind due to use of argparse the generic RAG demo can not be launched the usual way chainlit is started. 
+
+```bash
+chainlit run generic_rag/app.py  # will not work
+```
+
+Instead, the app can be launched and debugged the usual way.
+
+```bash
+python generic_rag/app.py -p data  # will work
+python generic_rag/app.py --help  # will work and prints command line options
+```
+
+
+## Chainlit starters
+
+Chainlit suggestions (starters) can be set with the `CHAINLIT_STARTERS` environment variable.
+The variable should be a JSON array of objects with `label` and `message` properties.
+An example is given below
+
+```
+
+CHAINLIT_STARTERS=[{"label":"Label 1","message":"Message one."},{"label":"Label 2","message":"Message two."},{"label":"Label 3","message":"Message three."}]
+
+```