Description
The Install section in the README is confusing for first-time users.
Under Option 1 (self-hosted), the quickstart only shows exporting ANTHROPIC_API_KEY and OPENAI_API_KEY. That reads like both are required and like Anthropic + OpenAI are the only supported setup. In reality self-hosted also supports OpenAI-only, Gemini via the OpenAI-compatible API, other embedding providers, and fully local models, yet none of that is obvious from the main path.
Under Option 2 (Rory Plans cloud), the text correctly says there are no LLM or embedding keys, then immediately has an “OpenAI-only: set LLM_PROVIDER=openai…” note and a self-hosted upgrading paragraph. Those belong under self-hosted, not cloud. Sitting after Option 2 makes it look like cloud users also configure provider keys.
Suggested fix: keep Option 1’s default as Anthropic + OpenAI, but add a short note that other provider paths exist (with a link to Concepts/CLI). Move the OpenAI-only note and the self-hosted upgrading blurb under Option 1 (or a separate self-hosted subsection). Leave Option 2 as token -> install only.
Description
The Install section in the README is confusing for first-time users.
Under Option 1 (self-hosted), the quickstart only shows exporting ANTHROPIC_API_KEY and OPENAI_API_KEY. That reads like both are required and like Anthropic + OpenAI are the only supported setup. In reality self-hosted also supports OpenAI-only, Gemini via the OpenAI-compatible API, other embedding providers, and fully local models, yet none of that is obvious from the main path.
Under Option 2 (Rory Plans cloud), the text correctly says there are no LLM or embedding keys, then immediately has an “OpenAI-only: set LLM_PROVIDER=openai…” note and a self-hosted upgrading paragraph. Those belong under self-hosted, not cloud. Sitting after Option 2 makes it look like cloud users also configure provider keys.
Suggested fix: keep Option 1’s default as Anthropic + OpenAI, but add a short note that other provider paths exist (with a link to Concepts/CLI). Move the OpenAI-only note and the self-hosted upgrading blurb under Option 1 (or a separate self-hosted subsection). Leave Option 2 as token -> install only.