Skip to content

Commit

Permalink
docs(README): Add collapsible details sections for commands
Browse files Browse the repository at this point in the history 
- Introduce collapsible sections in the README for better organization.
- Group related commands under 'details' to enhance readability.
- Ensure each section provides relevant examples while maintaining a clean layout.
  • Loading branch information
[email protected] committed Nov 2, 2024
1 parent 0ece92c commit 5ef3f72
Show file tree
Hide file tree
Showing 4 changed files with 108 additions and 7 deletions.
31 changes: 28 additions & 3 deletions README-ja.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,14 @@ composer require guanguans/ai-commit --dev -v # ローカル

### クイックスタート

<details>
<summary>details</summary>

```shell
./ai-commit config set generators.bito_cli.binary bito-cli-binary... --global # Config Bito cli binary(Optional)
./ai-commit config set generators.bito_cli.binary bito-cli-binary... --global # Config Bito CLI binary(Optional)
./ai-commit config set generators.ernie_bot.api_key api-key... --global # Config Ernie API key
./ai-commit config set generators.ernie_bot_turbo.api_key api-key... --global # Config Ernie API key
./ai-commit config set generators.github_copilot_cli.binary gh-cli-binary... --global # Config Github cli binary(Optional)
./ai-commit config set generators.github_copilot_cli.binary gh-cli-binary... --global # Config Github CLI binary(Optional)
./ai-commit config set generators.github_models_cli.binary gh-cli-binary... --global # Config Github CLI binary(Optional)
./ai-commit config set generators.moonshot.api_key sk-... --global # Config Moonshot API key
./ai-commit config set generators.openai.api_key sk-... --global # Config OpenAI API key
Expand All @@ -71,7 +74,7 @@ composer require guanguans/ai-commit --dev -v # ローカル
╰─ ./ai-commit commit --generator=bito_cli --no-edit --no-verify --ansi ─╯
1. Generating commit message: generating...

Please choice commit type [Automatically generate commit type]:
Please choose commit type [Automatically generate commit type]:
[auto ] Automatically generate commit type
[feat ] A new feature
[fix ] A bug fix
Expand Down Expand Up @@ -125,8 +128,13 @@ composer require guanguans/ai-commit --dev -v # ローカル
![](resources/docs/ai-commit-vhs.gif)
</details>
### コマンドの一覧
<details>
<summary>details</summary>
```shell
╰─ ./ai-commit list ─╯
Expand All @@ -151,8 +159,13 @@ composer require guanguans/ai-commit --dev -v # ローカル
thanks Thanks for using this tool.
```
</details>
### 設定の操作
<details>
<summary>details</summary>
```shell
./ai-commit config [set, get, unset, reset, list, edit] key value --global
Expand All @@ -164,8 +177,13 @@ composer require guanguans/ai-commit --dev -v # ローカル
./ai-commit config edit
```
</details>
### 自己更新
<details>
<summary>details</summary>
```shell
╰─ ./ai-commit self-update ─╯
Expand All @@ -177,8 +195,13 @@ Checking for a new version...
```
</details>
### コマンドヘルプ
<details>
<summary>details</summary>
```shell
╰─ ./ai-commit commit --help ─╯
Description:
Expand Down Expand Up @@ -211,6 +234,8 @@ Options:
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
```
</details>
## テスト
```shell
Expand Down
31 changes: 28 additions & 3 deletions README-zh_CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,14 @@ composer require guanguans/ai-commit --dev -v # 本地

### 快速开始

<details>
<summary>details</summary>

```shell
./ai-commit config set generators.bito_cli.binary bito-cli-binary... --global # Config Bito cli binary(Optional)
./ai-commit config set generators.bito_cli.binary bito-cli-binary... --global # Config Bito CLI binary(Optional)
./ai-commit config set generators.ernie_bot.api_key api-key... --global # Config Ernie API key
./ai-commit config set generators.ernie_bot_turbo.api_key api-key... --global # Config Ernie API key
./ai-commit config set generators.github_copilot_cli.binary gh-cli-binary... --global # Config Github cli binary(Optional)
./ai-commit config set generators.github_copilot_cli.binary gh-cli-binary... --global # Config Github CLI binary(Optional)
./ai-commit config set generators.github_models_cli.binary gh-cli-binary... --global # Config Github CLI binary(Optional)
./ai-commit config set generators.moonshot.api_key sk-... --global # Config Moonshot API key
./ai-commit config set generators.openai.api_key sk-... --global # Config OpenAI API key
Expand All @@ -71,7 +74,7 @@ composer require guanguans/ai-commit --dev -v # 本地
╰─ ./ai-commit commit --generator=bito_cli --no-edit --no-verify --ansi ─╯
1. Generating commit message: generating...

Please choice commit type [Automatically generate commit type]:
Please choose commit type [Automatically generate commit type]:
[auto ] Automatically generate commit type
[feat ] A new feature
[fix ] A bug fix
Expand Down Expand Up @@ -125,8 +128,13 @@ composer require guanguans/ai-commit --dev -v # 本地
![](resources/docs/ai-commit-vhs.gif)
</details>
### 列出命令
<details>
<summary>details</summary>
```shell
╰─ ./ai-commit list ─╯
Expand All @@ -151,8 +159,13 @@ composer require guanguans/ai-commit --dev -v # 本地
thanks Thanks for using this tool.
```
</details>
### 操作配置
<details>
<summary>details</summary>
```shell
./ai-commit config [set, get, unset, reset, list, edit] key value --global
Expand All @@ -164,8 +177,13 @@ composer require guanguans/ai-commit --dev -v # 本地
./ai-commit config edit
```
</details>
### 自我更新
<details>
<summary>details</summary>
```shell
╰─ ./ai-commit self-update ─╯
Expand All @@ -177,8 +195,13 @@ Checking for a new version...
```
</details>
### 命令帮助
<details>
<summary>details</summary>
```shell
╰─ ./ai-commit commit --help ─╯
Description:
Expand Down Expand Up @@ -211,6 +234,8 @@ Options:
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
```
</details>
## 测试
```shell
Expand Down
27 changes: 26 additions & 1 deletion README-zh_TW.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ composer require guanguans/ai-commit --dev -v # 本地安裝

### 快速開始

<details>
<summary>details</summary>

```shell
./ai-commit config set generators.bito_cli.binary bito-cli-binary... --global # Config Bito CLI binary(Optional)
./ai-commit config set generators.ernie_bot.api_key api-key... --global # Config Ernie API key
Expand Down Expand Up @@ -123,10 +126,15 @@ composer require guanguans/ai-commit --dev -v # 本地安裝
```
![](docs/ai-commit-vhs.gif)
![](resources/docs/ai-commit-vhs.gif)
</details>
### 指令列表
<details>
<summary>details</summary>
```shell
╰─ ./ai-commit list ─╯
Expand All @@ -151,8 +159,13 @@ composer require guanguans/ai-commit --dev -v # 本地安裝
thanks Thanks for using this tool.
```
</details>
### 設定操作
<details>
<summary>details</summary>
```shell
./ai-commit config [set, get, unset, reset, list, edit] key value --global
Expand All @@ -164,8 +177,13 @@ composer require guanguans/ai-commit --dev -v # 本地安裝
./ai-commit config edit
```
</details>
### 自動更新
<details>
<summary>details</summary>
```shell
╰─ ./ai-commit self-update ─╯
Expand All @@ -177,8 +195,13 @@ Checking for a new version...
```
</details>
### 指令說明
<details>
<summary>details</summary>
```shell
╰─ ./ai-commit commit --help ─╯
Description:
Expand Down Expand Up @@ -211,6 +234,8 @@ Options:
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
```
</details>
## 測試
```shell
Expand Down
26 changes: 26 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# ai-commit

[//]: # (https://looka.com)

[//]: # (<p align="center"><img src="resources/docs/logo.png" alt="logo" style="width: 62%; height: 62%;"></p>)
<p align="center"><img src="resources/docs/ai-commit-vhs.gif" alt="ai-commit-vhs"></p>

Expand Down Expand Up @@ -52,6 +53,9 @@ composer require guanguans/ai-commit --dev -v # local

### Quick start

<details>
<summary>details</summary>

```shell
./ai-commit config set generators.bito_cli.binary bito-cli-binary... --global # Config Bito CLI binary(Optional)
./ai-commit config set generators.ernie_bot.api_key api-key... --global # Config Ernie API key
Expand Down Expand Up @@ -125,8 +129,13 @@ composer require guanguans/ai-commit --dev -v # local
![](resources/docs/ai-commit-vhs.gif)
</details>
### List commands
<details>
<summary>details</summary>
```shell
╰─ ./ai-commit list ─╯
Expand All @@ -151,8 +160,13 @@ composer require guanguans/ai-commit --dev -v # local
thanks Thanks for using this tool.
```
</details>
### Operate config
<details>
<summary>details</summary>
```shell
./ai-commit config [set, get, unset, reset, list, edit] key value --global
Expand All @@ -164,8 +178,13 @@ composer require guanguans/ai-commit --dev -v # local
./ai-commit config edit
```
</details>
### Self update
<details>
<summary>details</summary>
```shell
╰─ ./ai-commit self-update ─╯
Expand All @@ -177,8 +196,13 @@ Checking for a new version...
```
</details>
### Command help
<details>
<summary>details</summary>
```shell
╰─ ./ai-commit commit --help ─╯
Description:
Expand Down Expand Up @@ -211,6 +235,8 @@ Options:
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
```
</details>
## Testing
```shell
Expand Down

0 comments on commit 5ef3f72

Please sign in to comment.