docs: Add API key and reference section to README

This commit is contained in:
Huakun Shen 2025-01-27 22:00:46 -05:00
parent dd29bd2650
commit 63e68f595e
No known key found for this signature in database

View File

@ -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/)