Skip to content

Commit

Permalink
docs: add more usage information to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
ramsey committed Aug 13, 2020
1 parent f3d3247 commit f02103f
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@ composer require ramsey/conventional-commits

## Usage

To use the `conventional-commits` console command to help you prepare commit
messages according to Conventional Commits, enter the following in your console:

``` bash
./vendor/bin/conventional-commits prepare
```

To see all the features of the console command, enter:

``` bash
./vendor/bin/conventional-commits
```

### Validating Commit Messages

To use the CaptainHook plugin to validate commit messages according to the
Expand All @@ -59,6 +72,9 @@ property in your `captainhook.json` file:

### Preparing Commit Messages

You can set up this library to prompt you to prepare commit messages when you
use `git commit`!

To use the CaptainHook plugin to prepare commit messages according to the
Conventional Commits specification, add the following to the `prepare-commit-msg`
property in your `captainhook.json` file:
Expand Down

0 comments on commit f02103f

Please sign in to comment.