Skip to content

Commit 4a7840d

Browse files
committed
improve README.md
1 parent 2117892 commit 4a7840d

2 files changed

Lines changed: 11 additions & 3 deletions

File tree

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ PINECONE_API_KEY=...
88
PINECONE_INDEX_NAME=...
99

1010
## Index API key
11-
INDEX_API_KEY=...
11+
INDEX_API_KEY=<create-your-own-key-to-secure-document-indexing>

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# LangChainDoc.com - Backend RAG System
1+
# LangChainDoc.com - Backend RAG System 🦜🔗
22

33
The backend powering [LangChainDoc.com](https://langchaindoc.com) - a RAG system for querying LangChain documentation.
44

@@ -15,6 +15,14 @@ This project provides the backend for LangChainDoc.com, enabling querying of Lan
1515
- **Semantic Search**: Find relevant documentation based on meaning
1616
- **Context-Aware Responses**: Responses consider multiple documentation sources
1717

18+
## Supported Providers
19+
20+
This project has been tested with:
21+
- **Vector Database**: Pinecone
22+
- **LLM**: OpenAI
23+
24+
The system is structured to work with other providers, but implementations for alternatives would need to be added.
25+
1826
## Getting Started
1927

2028
1. Copy `.env.example` to `.env`
@@ -26,7 +34,7 @@ cp .env.example .env
2634

2735
3. Running with LangGraph Studio
2836
- **Mac users**: Use LangGraph Studio directly
29-
- **Windows users**: Follow [this tutorial](https://langchain-ai.github.io/langgraph/tutorials/langgraph-platform/local-server/#langgraph-studio-web-ui) to set up LangGraph Studio
37+
- **Windows/Linux users**: Follow [this tutorial](https://langchain-ai.github.io/langgraph/tutorials/langgraph-platform/local-server/#langgraph-studio-web-ui) to set up LangGraph Studio
3038

3139
## Integration with Frontend
3240

0 commit comments

Comments
 (0)