From 4ec9cac82be93d738fc3e643f7a95c38840afcc7 Mon Sep 17 00:00:00 2001 From: Kevin Wan Date: Sun, 23 Jun 2024 11:47:17 +0800 Subject: [PATCH] chore: update readme for goctl installation (#4206) --- readme-cn.md | 11 +++-------- readme.md | 11 +++-------- 2 files changed, 6 insertions(+), 16 deletions(-) diff --git a/readme-cn.md b/readme-cn.md index 50ef6522b..c796ffaa9 100644 --- a/readme-cn.md +++ b/readme-cn.md @@ -118,18 +118,13 @@ GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/zeromicro # For Mac brew install goctl - # docker for amd64 architecture + # docker for all platforms docker pull kevinwan/goctl - # run goctl like + # run goctl docker run --rm -it -v `pwd`:/app kevinwan/goctl --help - - # docker for arm64(Mac) architecture - docker pull kevinwan/goctl:latest-arm64 - # run goctl like - docker run --rm -it -v `pwd`:/app kevinwan/goctl:latest-arm64 goctl --help ``` - 确保 goctl 可执行 + 确保 goctl 可执行,并且在 $PATH 环境变量里。 2. 快速生成 api 服务 diff --git a/readme.md b/readme.md index c01048aab..1bf007760 100644 --- a/readme.md +++ b/readme.md @@ -125,18 +125,13 @@ go get -u github.com/zeromicro/go-zero # For Mac brew install goctl - # docker for amd64 architecture + # docker for all platforms docker pull kevinwan/goctl - # run goctl like + # run goctl docker run --rm -it -v `pwd`:/app kevinwan/goctl --help - - # docker for arm64(Mac) architecture - docker pull kevinwan/goctl:latest-arm64 - # run goctl like - docker run --rm -it -v `pwd`:/app kevinwan/goctl:latest-arm64 --help ``` - make sure goctl is executable. + make sure goctl is executable and in your $PATH. 3. Create the API file, like greet.api, you can install the plugin of goctl in vs code, api syntax is supported.