From 63e68f595e4a5eee59a15bb11e56093e0848eb69 Mon Sep 17 00:00:00 2001 From: Huakun Shen Date: Mon, 27 Jan 2025 22:00:46 -0500 Subject: [PATCH] docs: Add API key and reference section to README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 62eeafc..ac97cbe 100644 --- a/README.md +++ b/README.md @@ -29,3 +29,13 @@ This is to prevent indexing other files you may not want to index, like lock fil ![](https://i.imgur.com/SMwsks7.png) ![](https://i.imgur.com/KPkwhMN.png) + +## API Key + +You need to supply an OpenAI API key to use this extension. It's kept locally with encryption. +It's used for running embedding and LLM model. So if you index lots of files and directories, it may cost you some money. +Index only the files you need. + +## Reference + +- [Langchain RAG](https://js.langchain.com/docs/concepts/rag/)