openkruise
/
kruise-rollout-api
mirror of https://github.com/openkruise/kruise-rollout-api.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update README for API usage 

Signed-off-by: 守辰 <shouchen.zz@alibaba-inc.com>
This commit is contained in:
守辰 2024-01-25 10:27:10 +08:00
parent baf8a18a34
commit 1de4d5db2b
1 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -6,14 +6,35 @@ The canonical location of the Kruise Rollout API definition and client.
| Kruise-Rollout-API | Kruise-rollout |
|--------------------|------------------|
| 0.4 | <= 0.4 |
| 0.5 | 0.5 |
| 0.4.1 | <= 0.4 |
| 0.5.0 | 0.5 |
## Where does it come from?
`kruise-rollout-api` is synced from [https://github.com/openkruise/rollouts/tree/master/api](https://github.com/openkruise/rollouts/tree/master/api).
Code changes are made in that location, merged into `openkruise/rollouts` and later synced here.
### How to get it
To get the latest version, use go1.16+ and fetch using the `go get` command. For example:
```
go get github.com/openkruise/kruise-rollout-api@latest
```
To get a specific version, use go1.11+ and fetch the desired version using the `go get` command. For example:
```
go get github.com/openkruise/kruise-rollout-api@v0.4.1
```
### How to use it
please refer to the [example](examples/create-update-delete-rollout)
## Things you should NOT do
[https://github.com/openkruise/rollouts/tree/master/api](https://github.com/openkruise/rollouts/tree/master/api) is synced to here.