Skip to content

Commit

Permalink
docs(readme): add new options
Browse files Browse the repository at this point in the history
  • Loading branch information
its-danny committed Nov 23, 2023
1 parent 72ba166 commit fcbbaae
Showing 1 changed file with 29 additions and 10 deletions.
39 changes: 29 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,34 +96,34 @@ koji altogether.
## Configuration
Config files are prioritized in the following order:
Config values are prioritized in the following order:
- Passed in via `--config`
- Passed in as arguments (see: `koji --help`)
- Read from file passed in via `--config`
- `.koji.toml` in the working directory
- `~/.config/koji/config.toml`
- The [default](https://github.com/its-danny/koji/blob/main/meta/config/default.toml) config
### Options
#### `emoji`
#### `autocomplete`
- Type: `bool`
- Optional: `true`
- Description: Prepend the commit summary with relevant emoji based on commit type.
- Description: Enables auto-complete for scope prompt via scanning commit history.
```toml
emoji = true
autocomplete = true
```
#### `autocomplete`
#### `breaking-changes`
- Type: `bool`
- Optional: `true`
- Description: Enables auto-complete for scope prompt via scanning commit history.
- Description: Enables breaking change prompt.
```toml
autocomplete = true
breaking_changes = true
```
#### `commit_types`
#### `commit-types`
- Type: `Vec<CommitType>`
- Optional: `true`
Expand All @@ -134,3 +134,22 @@ name = "feat"
emoji = "✨"
description = "A new feature"
```
#### `emoji`
- Type: `bool`
- Optional: `true`
- Description: Prepend the commit summary with relevant emoji based on commit type.
```toml
emoji = true
```
#### `issues`
- Type: `bool`
- Optional: `true`
- Description: Enables issue prompt, which will append a reference to an issue in the commit body.
```toml
issues = true
```

0 comments on commit fcbbaae

Please sign in to comment.