Skip to content

Commit a627396

Browse files
committed
feat(docs): Update docs
Updates the README.md file to clarify usage instructions and provide more detail about available options. This ensures users have a comprehensive understanding of how to utilize the `smart-git-commit` tool. The changes improve the tool's usability and reduce potential confusion. Affected files: - M README.md
1 parent 6baaac6 commit a627396

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ usage: smart-git-commit [-h] [--repo-path REPO_PATH] [--non-interactive]
9494
[--ollama-host OLLAMA_HOST]
9595
[--ollama-model OLLAMA_MODEL] [--no-ai]
9696
[--timeout TIMEOUT] [--verbose] [--skip-hooks]
97+
[--no-revert]
9798
9899
Smart Git Commit Workflow with Ollama Integration
99100
@@ -110,6 +111,7 @@ options:
110111
--timeout TIMEOUT Timeout in seconds for HTTP requests (default: 10)
111112
--verbose Show verbose debug output
112113
--skip-hooks Skip Git hooks when committing (useful if pre-commit is not installed)
114+
--no-revert Don't automatically revert staged changes on error
113115
```
114116

115117
## Example Commit
@@ -379,6 +381,7 @@ MIT
379381
- Added checks to prevent incomplete staging and failed commits
380382
- Added detection and handling of pre-commit hooks with --skip-hooks option
381383
- Added automatic fixes for "No module named pre_commit" errors
384+
- Added automatic revert system to clean up staged changes on error or interruption
382385
- Expanded troubleshooting documentation with common error solutions
383386
- Added relative path resolution to prevent path duplication issues
384387

0 commit comments

Comments
 (0)