You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Clarify the README by addressing several points:
* Configuration path examples are now bulleted and
bolded by OS for better clarity in the Installation
section.
* The commit confirmation keys in the Usage section
are updated from `y/n` to `CTRL-X`/`ESC` to reflect
the current keybindings.
* Added a detailed usage example block.
Copy file name to clipboardExpand all lines: README.md
+23-2Lines changed: 23 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,10 @@ go install github.com/rm-hull/git-commit-summary
18
18
19
19
### Set up your API key
20
20
21
-
`git-commit-summary` is XDG compliant, meaning it looks for its configuration file in a standard location. Create a `config.env` file in your XDG config home directory (e.g., `~/.config/git-commit-summary/config.env` on Linux, `~/Library/Application Support/git-config-summary/config.env` on macOS, or `%USERPROFILE%\.config\git-commit-summary\config.env` on Windows).
21
+
`git-commit-summary` is XDG compliant, meaning it looks for its configuration file in a standard location. Create a `config.env` file in your XDG config home directory, e.g. on:
You can configure the LLM provider by setting the `LLM_PROVIDER` environment variable. The supported providers are `google` (default) and `openai`.
24
27
@@ -74,7 +77,25 @@ Once installed, check that the executable is on the $PATH, with `git-commit-summ
74
77
75
78
3. **Confirm the commit:**
76
79
77
-
The tool will display the generated commit summary and ask for your confirmation. Type `y` to accept and commit, or `n` to abort.
80
+
The tool will display the generated commit summary and ask for your confirmation. Note that it is possible to amend the message, if necessary. Type `CTRL-X` to accept and commit, or `ESC` to abort.
0 commit comments