From 39c17a39cf8441eb455eb00548b5a1aac2cf7276 Mon Sep 17 00:00:00 2001 From: sado Date: Fri, 13 Oct 2023 17:15:16 +0800 Subject: [PATCH] update readme --- README.md | 33 +++++++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ca10d8f..76e0c63 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Some practical tools、 algorithms written in Go -- [x] [**p2c grpc balancer**](https://github.com/sado0823/go-kitx/tree/master/grpc/balancer/p2c) +## [**p2c grpc balancer**](https://github.com/sado0823/go-kitx/tree/master/grpc/balancer/p2c) ```go // example func test() { @@ -18,7 +18,7 @@ func test() { } ``` -- [x] [**ast rule engine**](https://github.com/sado0823/go-kitx/tree/master/kit/rule) +## [**ast rule engine**](https://github.com/sado0823/go-kitx/tree/master/kit/rule) __supported operator__ @@ -70,7 +70,7 @@ func main(){ ``` -- [x] [**start app with http and grpc**](https://github.com/sado0823/go-kitx/tree/master) +## [**start app with http and grpc**](https://github.com/sado0823/go-kitx/tree/master) ![img.png](docs/image/img.png) @@ -126,7 +126,7 @@ func Test_NewApp(t *testing.T) { } ``` -- [x] [**kit**](https://github.com/sado0823/go-kitx/tree/master/grpc/balancer/p2c) +## [**kit**] ```go 1) consistent hash 2) bbr、token、period ratelimit @@ -135,3 +135,28 @@ func Test_NewApp(t *testing.T) { 5) log plugin 6) go ast rule engine ``` + +## [**CMD**](https://github.com/sado0823/go-kitx/tree/master/cmd) +```shell +❯ ./kitx -h + +NAME: + kitx - ⭐️ cli command for go-kitx + +USAGE: + kitx [global options] command [command options] [arguments...] + +VERSION: + v0.0.1 + +COMMANDS: + upgrade, u upgrade kitx tools + new, n generate project from template + complete, c complete a task on the list + help, h Shows a list of commands or help for one command + +GLOBAL OPTIONS: + --help, -h show help (default: false) + --version, -v print the version (default: false) + +``` \ No newline at end of file