Skip to content

Commit

Permalink
📝 Add or update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Robin Louarn committed Jul 17, 2024
1 parent 3daad28 commit f1680d6
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
Expand Up @@ -129,7 +129,7 @@ The cli has some built-in configuration options that you can tweak at your own p
- **Automatic git add**: Enable or disable the automatic `git add .` every time you use the commit command.
- **Emoji format**: Switch between the emoji format.
- **Message prompt**: Enable or disable the message prompt.
- **Scope prompt**: Enable or disable [conventional commits scope prompt](https://www.conventionalcommits.org/en/v1.0.0/#summary).
- **Scope prompt**: Enable or disable the [conventional commits scope prompt](https://www.conventionalcommits.org/en/v1.0.0/#summary), or specify your own predefined scopes.
- **Gitmojis api URL**: Set a custom URL to use it as the library of gitmojis.

You can configure these options via (in order of precedence):
Expand All @@ -147,7 +147,7 @@ If no user configuration is found, a set of default values will be used.
"gitmoji": {
"autoAdd": false,
"emojiFormat": "code | emoji",
"scopePrompt": false,
"scopePrompt": false | ["feat", "fix", "ci", "build"],
"messagePrompt": false,
"capitalizeTitle": true,
"gitmojisUrl": "https://gitmoji.dev/api/gitmojis"
Expand All @@ -161,7 +161,7 @@ If no user configuration is found, a set of default values will be used.
{
"autoAdd": false,
"emojiFormat": "code | emoji" ,
"scopePrompt": false,
"scopePrompt": false | ["feat", "fix", "ci", "build"],
"messagePrompt": false,
"capitalizeTitle": true,
"gitmojisUrl": "https://gitmoji.dev/api/gitmojis"
Expand Down

0 comments on commit f1680d6

Please sign in to comment.