Description
The AGENTS.md documents the provider system (create src/providers/my-provider.ts, add to BUILTIN_PROVIDERS, wire into createProvider()), but the user-facing README does not explain how to add a new provider or use the custom provider entry.
Problem Statement
Users who want to point commit-echo at a non-builtin OpenAI-compatible endpoint have no clear documentation, leading to confusion around the __custom__ provider key and CUSTOM_API_KEY env var.
Proposed Solution
Add a "Custom Providers" section to the README covering:
- How to use the custom provider key
- Setting
COMMIT_ECHO_BASE_URL / CUSTOM_API_KEY
- How to contribute a new builtin provider
Additional Context
Relevant constants: CUSTOM_PROVIDER_KEY and CUSTOM_API_KEY_ENV in src/providers/registry.ts:3-4.
Description
The AGENTS.md documents the provider system (create
src/providers/my-provider.ts, add toBUILTIN_PROVIDERS, wire intocreateProvider()), but the user-facing README does not explain how to add a new provider or use the custom provider entry.Problem Statement
Users who want to point commit-echo at a non-builtin OpenAI-compatible endpoint have no clear documentation, leading to confusion around the
__custom__provider key andCUSTOM_API_KEYenv var.Proposed Solution
Add a "Custom Providers" section to the README covering:
COMMIT_ECHO_BASE_URL/CUSTOM_API_KEYAdditional Context
Relevant constants:
CUSTOM_PROVIDER_KEYandCUSTOM_API_KEY_ENVinsrc/providers/registry.ts:3-4.