From 01053b2df5ccd5f4053086372b194ce7c43d1f56 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=9D=8E=E5=AF=BB=E6=AC=A2?= <lxh@cxh.cn>
Date: Tue, 17 Oct 2023 16:37:29 +0800
Subject: [PATCH] first commit

---
 readme.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/readme.md b/readme.md
index 019231f..b96255c 100644
--- a/readme.md
+++ b/readme.md
@@ -1,4 +1,43 @@
 ### 手动打包镜像
 ```shell
 docker build --push -t repo.lxh.io/lxh/drone-kuboard:latest .
+```
+
+### 使用方式
+```yaml
+kind: pipeline
+type: docker
+name: BuildContainerImage
+
+
+steps:
+  # 更新测试环境
+  - name: UpdateTesting
+    image: repo.lxh.io/lxh/drone-kuboard
+    settings:
+      # 执行操作 restart | update
+      action: restart
+      # 固定句式
+      kind: deployments
+      # 集群名称
+      cluster: test
+      # 命名空间
+      namespace: test-ns
+      # deployments名称
+      name: test-dep
+      # 镜像，如果是更新，image和tag必须填，不然报错
+      image: xxxx
+      # 新的Tag，如果git事件是tag的话，可以保持下面的不变，具体视实际情况而定
+      tag: ${DRONE_SEMVER_SHORT}
+      # Kuboard服务地址
+      kuboard_uri: https://kuboard.example.com/
+      # Kuboard账号
+      kuboard_username:
+        from_secret: kuboard_username
+      # Kuboard访问AccessKey
+      kuboard_key:
+        from_secret: kuboard_key
+    when:
+      status:
+        - "success"
 ```
\ No newline at end of file