Skip to content

Commit

Permalink
docs(README): add FAQ section
Browse files Browse the repository at this point in the history
  • Loading branch information
liuyinz committed Oct 5, 2023
1 parent 0843ecd commit 8849fe3
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ generate and update changelog for project. Call `git-cliff-menu` to start.
- [Usage](#usage)
- [Customization](#customization)
- [Todo](#todo)
- [FAQ](#faq)
- [License](#license)

<!-- markdown-toc end -->
Expand Down Expand Up @@ -76,6 +77,14 @@ Clone and add to `load-path`, require the package.

- [x] support range arguments

## FAQ

- no `--repository` and `--workdir` options support?

Actually in the earlier versions, both options are supported. However, `git-cliff-menu` is designed to run in the root dir
of current repository by force, which means equivalent to `--workdir . --repository .` always. Due to same reason, multi-value of
`--repository` is disabled either in `git-cliff.el`.

## License

See [LICENSE](LICENSE).
Expand Down

0 comments on commit 8849fe3

Please sign in to comment.