Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
axetroy committed Oct 3, 2021
1 parent 004f3bb commit 4282414
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 16 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ An elegant changelog generator.

Focus on **Elegant**/**Simple**/**Efficient**/**Scalable**

[Feel the magic online](https://axetroy.github.io/whatchanged/)
[Feel the magic online](https://whatchanged-community.github.io/whatchanged/)

Feature:

Expand All @@ -23,7 +23,7 @@ Feature:
- [x] Custom template file
- [x] Conventional Commits Parser
- [x] Generate multiple versions of change logs
- [x] [Github Action](https://github.com/axetroy/setup-whatchanged)
- [x] [Github Action](https://github.com/whatchanged-community/setup-whatchanged)

### Usage

Expand All @@ -50,18 +50,14 @@ ARGUMENTS:
OPTIONS:
--help Print help information.
--version Print version information.

--project Specify the project to be generated. It can be a relative path.
or an absolute path or even a remote Git URL. eg.
--project=/path/to/project/which/contains/.git/folder
--project=https://github.com/whatchanged-community/whatchanged.git
Defaults to "--project=$PWD".

--branch Specify clone branch. only works for remote git project.
Defaults to "--branch=master"

--output Write output to file. default write to stdout.

--fmt Specify the changelog format. Available options:
--fmt=md
--fmt=json
Expand Down
8 changes: 2 additions & 6 deletions README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

致力于**优雅**/**简单**/**高效**/**可扩展**

[在线感受魔法](https://axetroy.github.io/whatchanged/)
[在线感受魔法](https://whatchanged-community.github.io/whatchanged/)

特性:

Expand All @@ -23,7 +23,7 @@
- [x] 自定义模版文件
- [x] 常规的 commit 解析器
- [x] 支持多个版本的变更日志生成
- [x] [Github Action](https://github.com/axetroy/setup-whatchanged)
- [x] [Github Action](https://github.com/whatchanged-community/setup-whatchanged)

### 使用

Expand All @@ -50,18 +50,14 @@ ARGUMENTS:
OPTIONS:
--help Print help information.
--version Print version information.

--project Specify the project to be generated. It can be a relative path.
or an absolute path or even a remote Git URL. eg.
--project=/path/to/project/which/contains/.git/folder
--project=https://github.com/whatchanged-community/whatchanged.git
Defaults to "--project=$PWD".

--branch Specify clone branch. only works for remote git project.
Defaults to "--branch=master"

--output Write output to file. default write to stdout.

--fmt Specify the changelog format. Available options:
--fmt=md
--fmt=json
Expand Down
4 changes: 0 additions & 4 deletions cmd/whatchanged/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,14 @@ ARGUMENTS:
OPTIONS:
--help Print help information.
--version Print version information.
--project Specify the project to be generated. It can be a relative path.
or an absolute path or even a remote Git URL. eg.
--project=/path/to/project/which/contains/.git/folder
--project=https://github.com/whatchanged-community/whatchanged.git
Defaults to "--project=$PWD".
--branch Specify clone branch. only works for remote git project.
Defaults to "--branch=master"
--output Write output to file. default write to stdout.
--fmt Specify the changelog format. Available options:
--fmt=md
--fmt=json
Expand Down

0 comments on commit 4282414

Please sign in to comment.