Skip to content

Commit cb3cc27

Browse files
committed
docs: Move .env info earlier in README
Move notes about local development configuration overrides (using a `.env` file) and the XDG Base Directory link to immediately follow the general configuration setup section. This ensures crucial setup information is not buried lower in the document.
1 parent b847dd7 commit cb3cc27

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ go install github.com/rm-hull/git-commit-summary
2222

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

25+
For local development or repository-specific overrides, you can still create a `.env` file in your git repository root.
26+
27+
For more information on the XDG Base Directory Specification, see: [https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)
28+
2529
#### Google
2630

2731
Add your Gemini API key to the `config.env` file:
@@ -52,10 +56,6 @@ OPENAI_BASE_URL="http://localhost:8080/v1"
5256
OPENAI_MODEL="Meta-Llama-3.1-8B-Instruct-Q4_K_M"
5357
```
5458

55-
For local development or repository-specific overrides, you can still create a `.env` file in your git repository root.
56-
57-
For more information on the XDG Base Directory Specification, see: [https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)
58-
5959
## Usage
6060

6161
Once installed, check that the executable is on the $PATH, with `git-commit-summary --version`. Then, as part of your development workflow

0 commit comments

Comments
 (0)