From 1e1df8c204f6771719f85d8402128d72138bb863 Mon Sep 17 00:00:00 2001
From: Paul Buetow <paul@buetow.org>
Date: Sat, 16 Aug 2025 14:58:03 +0300
Subject: llm: add pluggable provider with OpenAI default; extensive logging;
 LSP completion integration with TextEdit, param-aware prompts; remove idle
 gating; label/filter improvements; docs update

---
 README.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 3c1d45f..8fd42bd 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,16 @@
 
 Hexai, the AI LSP for the Helix editor.
 
-At the moment this project is only in the bainstorming phase.
+At the moment this project is only in the brainstorming phase.
 
+## LLM provider
+
+Hexai exposes a simple LLM provider interface and uses OpenAI by default for
+code completion when `OPENAI_API_KEY` is present in the environment.
+
+- Required: set `OPENAI_API_KEY` to your OpenAI API key.
+- Optional: set `OPENAI_MODEL` (default: `gpt-4o-mini`).
+- Optional: set `OPENAI_BASE_URL` to point at a compatible endpoint.
+
+If no key is configured, Hexai will fall back to a basic, local completion.
 
-- 
cgit v1.2.3