chore: update some preview images and update readme docs

Author: inhere

.github/workflows/release.yml

@@ -13,11 +13,13 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [8.0]
+        php: [8.1]
 
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Set ENV for github-release
         # https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
@@ -48,7 +50,7 @@ jobs:
         id: changelog
         run: |
           wget -c -q https://github.com/inhere/kite/releases/latest/download/kite.phar
-          php kite.phar git cl prev last --style gh-release --no-merges --fetch-tags --unshallow --file changelog.md
+          php kite.phar git cl prev last --style gh-release --no-merges --fetch-tags --file changelog.md
           cat changelog.md
 
       # https://github.com/softprops/action-gh-release

README.md

@@ -37,6 +37,11 @@ Generic PHP command line flags parse library
 - Support binding named arguemnt
 - Support define array argument
 
+### Quick build command
+
+- Use `Toolkit\PFlag\CliCmd` to quickly build a simple command application
+- Use `Toolkit\PFlag\CliApp` to quickly build a command application that supports subcommands
+
 ## Install
 
 - Require PHP 8.0+

README.zh-CN.md

@@ -38,6 +38,11 @@
 - 支持绑定命名参数
 - 支持定义数组参数
 
+### 快速构建命令
+
+- 使用 `Toolkit\PFlag\CliCmd` 可以快速的构建一个简单的命令应用
+- 使用 `Toolkit\PFlag\CliApp` 可以快速的构建一个支持子命令的命令应用
+
 ## 安装
 
 - Require PHP 8.0+

example/changelog.md

@@ -16,7 +16,7 @@
 
 // run demo:
 // php example/cliapp.php
-
+// php example/cliapp.php test2 -h
 $cli = CliApp::newWith(static function (CliApp $app): void {
     $app->setName('myApp');
     $app->setDesc('my cli application. v1.0.1');

example/cliapp.php

@@ -14,7 +14,7 @@
 require dirname(__DIR__) . '/test/bootstrap.php';
 
 // run demo:
-// php example/clicmd.php
+// php example/clicmd.php -h
 // php example/clicmd.php --name inhere value1
 // php example/clicmd.php --age 23 --name inhere value1
 

example/clicmd.php

@@ -19,8 +19,8 @@
 require dirname(__DIR__) . '/test/bootstrap.php';
 
 // run demo:
-// php example/flag-demo.php -h
-// php example/sflags-demo.php --name inhere --age 99 --tag go -t php -t java -f arg0 arr0 arr1
+// php example/flags-demo.php -h
+// php example/flags-demo.php --name inhere --age 99 --tag go -t php -t java -f arg0 arr0 arr1
 $flags = $_SERVER['argv'];
 // NOTICE: must shift first element.
 $scriptFile = array_shift($flags);

example/flags-demo.php

@@ -15,6 +15,7 @@
 require dirname(__DIR__) . '/test/bootstrap.php';
 
 // run demo:
+// php example/sflags-demo.php -h
 // php example/sflags-demo.php --name inhere --age 99 --tag go -t php -t java -f arg0 arr0 arr1
 $flags = $_SERVER['argv'];
 // NOTICE: must shift first element.