From 1de4d5db2b2d93b23737703be2e126d9f3781809 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=AE=88=E8=BE=B0?= Date: Thu, 25 Jan 2024 10:27:10 +0800 Subject: [PATCH] update README for API usage MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 守辰 --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e361849..eebd1da 100644 --- a/README.md +++ b/README.md @@ -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.