Skip to content

Commit

Permalink
docs(README): Update README for better clarity and additional features
Browse files Browse the repository at this point in the history
Revised commit message examples for clarity. Added section for changelog generation with usage instructions.
  • Loading branch information
tab committed Oct 15, 2024
1 parent a7b0fe1 commit 1e9c48a
Showing 1 changed file with 28 additions and 5 deletions.
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,7 @@ cmt
Review the generated commit message and choose whether to commit or not.

```sh
💬 Message:
feat(core): Add user authentication
💬 Message: feat(core): Add user authentication
Implemented JWT-based authentication for API endpoints. Users can now log in and receive a token for subsequent requests.
Expand All @@ -93,7 +92,7 @@ Type **y** to accept and commit the changes, or **n** to abort.
...
```
## Configuration
### Configuration
Optional prefix for the commit message can be set with the `--prefix` flag:
Expand All @@ -110,14 +109,38 @@ cmt -p "TASK-1234"
Resulting commit message:
```sh
💬 Message:
TASK-1234 feat(core): Add user authentication
💬 Message: TASK-1234 feat(core): Add user authentication
Implemented JWT-based authentication for API endpoints. Users can now log in and receive a token for subsequent requests.
Accept? (y/n):
```
### Changelog generation
Run the `cmt changelog` to generate a changelog based on your commit history:
```sh
cmt changelog sha1..sha2
```
```sh
cmt changelog v1.0.0..v1.1.0
```
The command will output the changelog in the following format:
```sh
# CHANGELOG
[1.1.0]
### Features
- **feat(core):** Add user authentication
...
```
## License
Distributed under the MIT License. See `LICENSE` for more information.
Expand Down

0 comments on commit 1e9c48a

Please sign in to comment.