Skip to content

Commit a6f2a1f

Browse files
authored
docs: update README with AI provider configuration (Issue A)
Adds an "AI Provider configuration" section to the README. This section documents the default OpenAI provider (`AI_PROVIDER=openai`) and lists the required environment variables: `OPENAI_API_KEY`, `OPENAI_MODEL` (default `gpt-4o-mini`), and `OPENAI_BASE_URL` (defaults to `https://api.openai.com/v1`). It also groups alternative provider keys (Anthropic, Gemini, Groq) under an optional section.
1 parent 5ae4058 commit a6f2a1f

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,16 @@ Open [http://localhost:3000](http://localhost:3000)
3838
## License
3939

4040
MIT
41+
42+
## AI Provider configuration
43+
44+
# Default provider (OpenAI)
45+
AI_PROVIDER=openai
46+
OPENAI_API_KEY=your_openai_api_key
47+
OPENAI_MODEL=gpt-4o-mini
48+
OPENAI_BASE_URL=https://api.openai.com/v1
49+
50+
# Alternative providers (optional)
51+
ANTHROPIC_API_KEY=your_anthropic_api_key
52+
GEMINI_API_KEY=your_gemini_api_key
53+
GROQ_API_KEY=your_groq_api_key

0 commit comments

Comments
 (0)