From 710e3cce590666b110ad5eb45be9e0e3302314b8 Mon Sep 17 00:00:00 2001
From: Tadashi <tadashi@cinnamon.is>
Date: Mon, 14 Oct 2024 21:46:30 +0700
Subject: [PATCH] docs: update README for GraphRAG instructions #none

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

diff --git a/README.md b/README.md
index d86a021..e15bcea 100644
--- a/README.md
+++ b/README.md
@@ -175,6 +175,13 @@ Default username / password are: `admin` / `admin`. You can setup additional use
 
 - Check the Resources tab and LLMs and Embeddings and ensure that your `api_key` value is set correctly from your `.env`. file. If it is not set, you can set it here.
 
+## Setup GraphRAG
+
+<small>NOTE: Currently GraphRAG feature only works with OpenAI or Ollama API.</small>
+
+- To use GraphRAG retriever feature, make sure to set `GRAPHRAG_API_KEY` environment variables (or in the `.env` file).
+- To use GraphRAG with local models (Ollama), set `USE_CUSTOMIZED_GRAPHRAG_SETTING=true` and tweak your settings in `kotaemon/settings.yaml.example`.
+
 ## Setup local models (for local / private RAG)
 
 See [Local model setup](docs/local_model.md).