diff --git a/README.md b/README.md index 44c8b13..30e38ba 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,8 @@ Note: The non-interactive flags `--yes`, `-y`, and `--auto` expect staged change Run `commit-echo init` to configure your provider and model. Configuration is stored in `~/.config/commit-echo/config.json`. +To add a custom provider, create a file in the `src/providers` directory (e.g., `src/providers/my-provider.ts`) and add it to the `BUILTIN_PROVIDERS` list. Then, wire it into the `createProvider()` function. You can also use the `__custom__` provider key and set the `CUSTOM_API_KEY` environment variable to point to your custom endpoint. + If you want `git commit` to prefill the first suggestion automatically, run `commit-echo init --install-hook` from inside a Git repository. This installs both a `prepare-commit-msg` hook (prefills the first suggestion) and a `post-commit` hook (logs the committed message for style learning). The hooks skip merge commits, cherry-picks, amend flows, and any commit where a message was already supplied. ### Options