Skip to content

Commit 9889ce4

Browse files
committed
docs: Clarify config paths and update usage keys
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.
1 parent 797c914 commit 9889ce4

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@ go install github.com/rm-hull/git-commit-summary
1818

1919
### Set up your API key
2020

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:
22+
* **Linux**: `~/.config/git-commit-summary/config.env`,
23+
* **MacOS**: `~/Library/Application Support/git-config-summary/config.env`, or
24+
* **Windows**: `%USERPROFILE%\.config\git-commit-summary\config.env`.
2225

2326
You can configure the LLM provider by setting the `LLM_PROVIDER` environment variable. The supported providers are `google` (default) and `openai`.
2427

@@ -74,7 +77,25 @@ Once installed, check that the executable is on the $PATH, with `git-commit-summ
7477

7578
3. **Confirm the commit:**
7679

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.
81+
82+
```
83+
$ git commit-summary
84+
╭ Commit message ──────────────────────────────────────────────────────────╮
85+
│ docs: Clarify config paths and update usage keys │
86+
│ │
87+
│ Clarify the README by addressing several points: │
88+
│ │
89+
* Configuration path examples are now bulleted and │
90+
│ bolded by OS for better clarity in the Installation │
91+
│ section. │
92+
* The commit confirmation keys in the Usage section │
93+
│ are updated from `y/n` to `CTRL-X`/`ESC` to reflect │
94+
│ the current keybindings. │
95+
* Added a detailed usage example block. │
96+
╰──────────────────────────────────────────────────────────────────────────╯
97+
(Ctrl-X to commit, ESC to abort)
98+
```
7899
79100
## Flags
80101

0 commit comments

Comments
 (0)