Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
segersniels committed Oct 24, 2024
1 parent cfb0d56 commit 5496826
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# cmt

![demo](demo.gif)

`cmt` (short for commit) is a command-line tool designed to help developers write consistent and standardized commit messages across different commit conventions.

![demo](demo.gif)

## Conventions

Open source contributors often face a unique challenge when working across multiple projects: navigating the diverse landscape of commit conventions. Each repository may adhere to its own set of rules for structuring commit messages, from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to [Gitmoji](https://gitmoji.dev/), or even custom formats. This inconsistency can lead to confusion, reduced productivity, and potential errors in version control.
Expand Down Expand Up @@ -44,4 +44,4 @@ Follow the interactive prompts to construct your commit.
## Configuration

CMT uses a `.cmtrc.json` file to store configuration. You can edit this file manually or run `cmt init` to set up your preferences.
`cmt` uses a `.cmtrc.json` file to store configuration. You can edit this file manually or run `cmt init` to set up your preferences.

0 comments on commit 5496826

Please sign in to comment.