Skip to content

Commit 5f931e4

Browse files
committed
docs(readme): Update README.md and README-zh_CN.md
- Update usage information in README.md and README-zh_CN.md - Add gif usage example in README.md and README-zh_CN.md - Add testing information in README.md and README-zh_CN.md
1 parent 7c6ae41 commit 5f931e4

File tree

2 files changed

+38
-26
lines changed

2 files changed

+38
-26
lines changed

README-zh_CN.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,21 @@ composer require guanguans/music-dl:dev-master --dev -v --ignore-platform-req=ex
3939
## 使用
4040

4141
```shell
42-
╰─ ./music-dl --help ─╯
42+
╰─ ./music-dl list ─╯
43+
44+
Music DL refs/tags/4.1.6
45+
46+
USAGE: <command> [options] [arguments]
47+
48+
completion Dump the shell completion script
49+
inspire Display an inspiring quote
50+
music Search and download music
51+
self-update Allows to self-update a build application
52+
thanks Thanks for using this tool.
53+
```
54+
55+
```shell
56+
╰─ ./music-dl music --help ─╯
4357
Description:
4458
Search and download music
4559

@@ -63,22 +77,14 @@ Options:
6377
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
6478
```
6579

66-
```shell
67-
╰─ ./music-dl list ─╯
68-
69-
Music DL refs/tags/4.1.6
80+
![usage](resources/music-dl.gif)
7081

71-
USAGE: <command> [options] [arguments]
82+
## 测试
7283

73-
completion Dump the shell completion script
74-
inspire Display an inspiring quote
75-
music Search and download music
76-
self-update Allows to self-update a build application
77-
thanks Thanks for using this tool.
84+
```bash
85+
composer test
7886
```
7987

80-
![vhs](resources/music-dl.gif)
81-
8288
## 变更日志
8389

8490
请参阅 [CHANGELOG](CHANGELOG.md) 获取最近有关更改的更多信息。

README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,21 @@ composer require guanguans/music-dl:dev-master --dev -v --ignore-platform-req=ex
3939
## Usage
4040

4141
```shell
42-
╰─ ./music-dl --help ─╯
42+
╰─ ./music-dl list ─╯
43+
44+
Music DL refs/tags/4.1.6
45+
46+
USAGE: <command> [options] [arguments]
47+
48+
completion Dump the shell completion script
49+
inspire Display an inspiring quote
50+
music Search and download music
51+
self-update Allows to self-update a build application
52+
thanks Thanks for using this tool.
53+
```
54+
55+
```shell
56+
╰─ ./music-dl music --help ─╯
4357
Description:
4458
Search and download music
4559

@@ -63,22 +77,14 @@ Options:
6377
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
6478
```
6579

66-
```shell
67-
╰─ ./music-dl list ─╯
68-
69-
Music DL refs/tags/4.1.6
80+
![usage](resources/music-dl.gif)
7081

71-
USAGE: <command> [options] [arguments]
82+
## Testing
7283

73-
completion Dump the shell completion script
74-
inspire Display an inspiring quote
75-
music Search and download music
76-
self-update Allows to self-update a build application
77-
thanks Thanks for using this tool.
84+
```bash
85+
composer test
7886
```
7987

80-
![vhs](resources/music-dl.gif)
81-
8288
## Changelog
8389

8490
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

0 commit comments

Comments
 (0)