Skip to content

Commit

Permalink
feat(jzero): 更新 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jaronnie committed Apr 12, 2024
1 parent 819549b commit 0cfd4d4
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,34 @@
* 支持监听 unix socket
* 支持多 proto 多 service(多人开发友好)
* 加入开发中的各种案例请求
* 一键创建项目
* 一键生成各种代码

## 安装

```shell
go install github.com/jaronnie/jzero@latest
# 初始化
jzero init
# 启动服务
# 启动样例服务
jzero daemon
```

## 一键创建项目

```shell
jzero new --module=github.com/jaronnie/app1 --dir=./app1 --app=app1
cd app1
jzero gen
go mod tidy
go run main.go --config config.toml
```

## 开发

```shell
# gencode
task gencode
jzero gen

# run
task run
Expand All @@ -50,6 +62,6 @@ grpcurl -plaintext localhost:8000 credentialpb.credential/CredentialVersion
- [x] Support multi proto, multi service
- [x] Support api ~~multi api,~~ multi service
- [x] Warp rpc and api Response
- [ ] Support jzero gen
- [ ] Support jzero new
- [x] Support jzero gen
- [x] Support jzero new

20 changes: 20 additions & 0 deletions docs/src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,23 @@ title: 首页
* 支持监听 unix socket
* 支持多 proto 多 service(多人开发友好)
* 加入开发中的各种案例请求

## 快速开始

```shell
# 安装 goctl
go install github.com/zeromicro/go-zero/tools/goctl@latest
# 一键安装相关工具
goctl env check --install --verbose --force
# 安装 jzero
go install github.com/jaronnie/jzero@latest
# 一键创建项目
jzero new --module=github.com/jaronnie/app1 --dir=./app1 --app=app1
cd app1
# 一键生成代码
jzero gen
# 下载依赖
go mod tidy
# 启动项目
go run main.go --config config.toml
```

0 comments on commit 0cfd4d4

Please sign in to comment.