Skip to content

Commit 482f1e9

Browse files
committed
docs(options): add usage of list options
1 parent 4a0d5bb commit 482f1e9

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ Fixes some issues of commitizen-go and supports more new features.
1313

1414
## Features
1515

16-
- Multi-template support
17-
- Support more options of `git commit`
18-
- Use [bubbletea](https://github.com/charmbracelet/bubbletea) instead of [survey](https://github.com/AlecAivazis/survey) ([survey](https://github.com/AlecAivazis/survey) is no longer maintained).
19-
- Better unit tests.
16+
- Multi-template support.
17+
- More powerful and flexible template.
18+
- Support more options of `git commit`.
19+
- Use [huh](https://github.com/charmbracelet/huh) instead of [survey](https://github.com/AlecAivazis/survey) ([survey](https://github.com/AlecAivazis/survey) is no longer maintained).
2020

2121
## Getting Started
2222

@@ -265,10 +265,19 @@ Properties:
265265
| Property | Required | Default Value | Description |
266266
|:--------------|:---------|:--------------|:-------------------------------------------|
267267
| required | no | `false` | Whether a string value is required or not. |
268-
| default_value | no | - | The default value for this item. |
268+
| default_value | no | - | A list of default selection values. |
269269
| options | yes | - | The list of options to choose from. |
270270
| limit | no | `false` | The limit of the multiple selection list. |
271271

272+
#### list/multi_list Options
273+
274+
Properties:
275+
276+
| Property | Required | Description |
277+
|:---------|:---------|:---------------------------------|
278+
| key | yes | The message shown in the UI. |
279+
| value | yes | Unique identifier for the value. |
280+
272281
### Multiple Templates
273282

274283
You can define multiple templates in the `.czrc` file, separated by `---`:

0 commit comments

Comments
 (0)