Skip to content

Commit c49ac6b

Browse files
committed
chore: update fallback README from remote
1 parent f5cecf1 commit c49ac6b

File tree

1 file changed

+11
-4
lines changed
  • app/static/projects/tools/commit-for-me

1 file changed

+11
-4
lines changed

app/static/projects/tools/commit-for-me/README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ using AI, prompt you to review and edit it, then commit it for you.
1212

1313
![cfme demo](./demo/demo.gif)
1414

15+
> There is also a demo available showing how to use `cfme` from within
16+
> [Lazygit](https://github.com/jesseduffield/lazygit/).
17+
> Jump to the [Lazygit Integration](#lazygit) section below.
18+
1519
## Features ✨
1620

1721
- **AI-Powered Commit Messages** - Leverages modern AI models
@@ -275,7 +279,7 @@ There are three special template strings that `cfme` recognizes by default:
275279

276280
- `<__GIT_DIFF__>` (required): Replaced with the output of `git diff --cached`
277281
(i.e. the staged changes)
278-
- `<__RESPONSE__REQUIREMENTS__>` (required): Replaced with a list of requirements
282+
- `<__RESPONSE_FORMAT_REQUIREMENTS__>` (required): Replaced with a list of requirements
279283
that dictates how the AI should format its response. This is essential so
280284
that `cfme` can parse the AI's response.
281285
Note that these requirements merely dictate the format of the response, they
@@ -425,7 +429,9 @@ CFME_DEFAULT_PROMPT_VARIABLES_FILE_FETCH_URL
425429
426430
[Lazygit](https://github.com/jesseduffield/lazygit) is awesome.
427431
But `cfme` allows you to be even lazier! You can use `cfme`
428-
from within Lazygit's TUI to generate commit messages.
432+
from within Lazygit's TUI to generate commit messages:
433+
434+
![cfme lazygit demo](./demo/lazygit-demo.gif)
429435
430436
Just add the following custom command to your Lazygit config file
431437
(e.g. `~/.config/lazygit/config.yml`):
@@ -478,8 +484,9 @@ Example contributions include:
478484
- Added a new feature or fixed a bug? Pull request welcome!
479485
- Want to improve the documentation? Contributions are welcome!
480486
481-
See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to contribute.
487+
See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information on how to contribute.
482488
483489
## License
484490
485-
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
491+
This project is licensed under the MIT License. See the [LICENSE](./LICENSE)
492+
file for details.

0 commit comments

Comments
 (0)