From 212395430e191e39a8218fbd1ee0e8951a72c490 Mon Sep 17 00:00:00 2001
From: nor0x <nor0x@users.noreply.github.com>
Date: Sun, 8 Sep 2024 19:02:32 +0200
Subject: [PATCH] =?UTF-8?q?readme=20=F0=9F=93=96=20+=20no=20result=20text?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 WahlGPT.Common/Settings.cs |  2 +-
 readme.md                  | 43 ++++++++++++++++++++++++++++++++++----
 2 files changed, 40 insertions(+), 5 deletions(-)

diff --git a/WahlGPT.Common/Settings.cs b/WahlGPT.Common/Settings.cs
index 6f2c5a8..cf77fe7 100644
--- a/WahlGPT.Common/Settings.cs
+++ b/WahlGPT.Common/Settings.cs
@@ -49,7 +49,7 @@ public static IKernelMemory BuildKernelMemory()
 					  .WithSearchClientConfig(new SearchClientConfig
 					  {
 						  Temperature = 0.7,
-						  EmptyAnswer = "Auf diese Frage habe ich leider keine Antwort? 🤔"
+						  EmptyAnswer = "Auf diese Frage, kann ich leider keine Antwort im Wahlprogramm finden. 🤔",
 					  })
 					  .WithQdrantMemoryDb(QdrantHost, QdrantApiKey)
 					  .Build();
diff --git a/readme.md b/readme.md
index b2fc6d4..729c327 100644
--- a/readme.md
+++ b/readme.md
@@ -1,11 +1,46 @@
 # WahlGPT
-LLM + RAG to generate answers about the program of the parties for the 2024 Austrian legislative election.
 
+<img src="https://raw.githubusercontent.com/nor0x/wahlgpt/main/WahlGPT.Web/wwwroot/images/header-img.png" width="250" height="250">
+ 
+
+[![Deploy to GitHub Pages](https://github.com/nor0x/wahlgpt/actions/workflows/main.yml/badge.svg)](https://github.com/nor0x/wahlgpt/actions/workflows/main.yml) 
+[![pages-build-deployment](https://github.com/nor0x/wahlgpt/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/nor0x/wahlgpt/actions/workflows/pages/pages-build-deployment)
+
+
+
+**LLM + RAG to generate answers about the program of the parties for the 2024 Austrian legislative election.**
+
+
+# Dependencies
+- .NET SDK >= 8
+- wasm workload
+- Azure Functions Core Tools
+
+# How to run
+```pwsh
+# run the backend function
+cd WahlGPT.Function
+func start
+
+# adapt settings (i.e. API_ENDPOINT from function) in WahlGPT.Common/Settings.cs
+# for development the following extensions for KernelMemory can be used:
+#.WithSimpleVectorDb()
+#.WithSimpleFileStorage()
+# with these you don't need a running qdrant instance - the vector db is stored in memory
+# feel free to plug in other models for embedding or text generation to experiment with different results
+
+#restore the wasm workloads
+cd WahlGPT.Web
+dotnet workload restore
+
+# run the frontend
+dotnet run
+```
 
 ## credits
 - html5up
-- openai
-- qdrant
 - semantic-kernel
 - semantic-memory
-- dotnet
\ No newline at end of file
+- qdrant
+- dotnet
+- openai
\ No newline at end of file