Skip to content
This repository has been archived by the owner on Feb 5, 2018. It is now read-only.

Commit

Permalink
docs(README): tweak the wording
Browse files Browse the repository at this point in the history
  • Loading branch information
stevemao committed Aug 7, 2015
1 parent 1b45bc3 commit 9db101d
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,9 @@
> Parse raw conventional commits

Adapted from code originally written by @ajoslin in [conventional-changelog](https://github.com/ajoslin/conventional-changelog).


## Conventional Commit Message Format

A minimum input should contain the raw message.
A minimum input should contain a raw message.

Each commit message consists of a a **header**, a **body** (optional) and a **footer** (optional).

Expand All @@ -35,7 +32,7 @@ The footer should contain any information about **Important Notes** (optional) a
<references>
```

This module will just parse the message itself. However, it is possible to include other fields such as hash, committer or date.
This module will only parse the message body. However, it is possible to include other fields such as hash, committer or date.

```
My commit message
Expand Down

0 comments on commit 9db101d

Please sign in to comment.