diff --git a/readme.md b/readme.md
index 4673efcd..ab3d6d94 100644
--- a/readme.md
+++ b/readme.md
@@ -1,8 +1,11 @@
-
-
# go-zero
+
+
+
-## 1. Backgrounds of go-zero
+## Backgrounds of go-zero
At the beginning of 2018, we decided to re-design our system, from monolithic architecture with Java+MongoDB to microservice architecture. After research and comparison, we chose to:
@@ -55,7 +55,7 @@ At the beginning of 2018, we decided to re-design our system, from monolithic ar
* easy to locate the problems
* easy to extend the features
-## 2. Design considerations on go-zero
+## Design considerations on go-zero
By designing the microservice architecture, we expected to ensure stability, as well as productivity. And from just the beginning, we have the following design principles:
@@ -69,7 +69,7 @@ By designing the microservice architecture, we expected to ensure stability, as
After almost half a year, we finished the transfer from a monolithic system to microservice system and deployed on August 2018. The new system guaranteed business growth and system stability.
-## 3. The implementation and features of go-zero
+## The implementation and features of go-zero
go-zero is a web and rpc framework that integrates lots of engineering practices. The features are mainly listed below:
@@ -91,27 +91,38 @@ As below, go-zero protects the system with a couple of layers and mechanisms:

-## 4. The simplified architecture that we use with go-zero
+## The simplified architecture that we use with go-zero
-## 5. Installation
+## Installation
Run the following command under your project:
```shell
go get -u github.com/zeromicro/go-zero
```
+## Upgrade
-## 6. Quick Start
+To upgrade from versions eariler than v1.3.0, run the following commands.
-0. full examples can be checked out from below:
+```shell
+go install github.com/zeromicro/go-zero/tools/goctl@latest
+```
+
+```shell
+goctl migrate —verbose —version v1.4.0
+```
+
+## Quick Start
+
+1. full examples can be checked out from below:
[Rapid development of microservice systems](https://github.com/zeromicro/zero-doc/blob/main/doc/shorturl-en.md)
[Rapid development of microservice systems - multiple RPCs](https://github.com/zeromicro/zero-doc/blob/main/docs/zero/bookstore-en.md)
-1. install goctl
+2. install goctl
`goctl`can be read as `go control`. `goctl` means not to be controlled by code, instead, we control it. The inside `go` is not `golang`. At the very beginning, I was expecting it to help us improve productivity, and make our lives easier.
@@ -138,7 +149,7 @@ go get -u github.com/zeromicro/go-zero
make sure goctl is executable.
-2. create the API file, like greet.api, you can install the plugin of goctl in vs code, api syntax is supported.
+3. create the API file, like greet.api, you can install the plugin of goctl in vs code, api syntax is supported.
```go
type (
@@ -163,7 +174,7 @@ go get -u github.com/zeromicro/go-zero
goctl api -o greet.api
```
-3. generate the go server-side code
+4. generate the go server-side code
```shell
goctl api go -api greet.api -dir greet
@@ -216,12 +227,12 @@ go get -u github.com/zeromicro/go-zero
Content-Length: 0
```
-4. Write the business logic code
+5. Write the business logic code
* the dependencies can be passed into the logic within servicecontext.go, like mysql, reds, etc.
* add the logic code in a logic package according to .api file
-5. Generate code like Java, TypeScript, Dart, JavaScript, etc. just from the api file
+6. Generate code like Java, TypeScript, Dart, JavaScript, etc. just from the api file
```shell
goctl api java -api greet.api -dir greet
@@ -229,24 +240,24 @@ go get -u github.com/zeromicro/go-zero
...
```
-## 7. Benchmark
+## Benchmark

[Checkout the test code](https://github.com/smallnest/go-web-framework-benchmark)
-## 8. Documents
+## Documents
* [Documents](https://go-zero.dev/)
* [Rapid development of microservice systems](https://github.com/zeromicro/zero-doc/blob/main/doc/shorturl-en.md)
* [Rapid development of microservice systems - multiple RPCs](https://github.com/zeromicro/zero-doc/blob/main/docs/zero/bookstore-en.md)
* [Examples](https://github.com/zeromicro/zero-examples)
-## 9. Chat group
+## Chat group
Join the chat via https://discord.gg/4JQvC5A4Fe
-## 10. Cloud Native Landscape
+## Cloud Native Landscape