From 696134c0f3a6ca32a9d8d175e1da9fae2b9a6b05 Mon Sep 17 00:00:00 2001
From: 173******10 <11618285+acewuye@user.noreply.gitee.com>
Date: Thu, 1 Dec 2022 03:26:56 +0000
Subject: [PATCH] update README.md

Signed-off-by: 173******10 <11618285+acewuye@user.noreply.gitee.com>
---
 README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 63 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 177fbb0..9008d01 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,69 @@
-### 背景 
+# Jenkins华为云OBS上传插件
 
-Jenkins是一个开源软件项目，是基于Java开发的一种持续集成工具，用于监控持续重复的工作，使软件项目可以进行持续集成.
+## 使用
+1.下载源码&编译
 
-### 项目简介
+```bash
+git clone https://gitee.com/HuaweiCloudDeveloper/obs-jenkins-plugins.git
+cd obs-jenkins-plugins
+mvn package -DskipTests
+```
+2.上传插件
+>系统管理 --> 插件管理 --> 高级 --> Deploy Plugin --> 选择文件 --> 上传target下的hpi文件 --> 重启Jenkins
 
-利用jenkins的插件机制，使jenkins可以使用HuaweiCloud OBS作为存储，包含但不限于插件上架到Jenkins插件市场，并且提供功能文档，使用文档，示例代码等等...
+3.修改项目，增加`构建后操作`，选择`华为云OBS上传`
+![](https://gitee.com/HuaweiCloudDeveloper/obs-jenkins-plugins.git/raw/master/image/step1.png)
 
-目前仓库提供一个基础版本，支持指定位置的文件转存到OBS，后续迭代版本的完整功能可以参考
+4.填写华为云OBS配置信息
+![](https://gitee.com/HuaweiCloudDeveloper/obs-jenkins-plugins.git/raw/master/image/step2.png)
+>本地路径为相对于workspace的路径，例如填写为/abc，则本地路径为${WORKSPACE}/abc
+> 
+> 本地路径可以设置为文件或目录。如果设置为文件则上传单个文件，设置为目录上传整个目录
 
-- [google-storage-plugin](https://gitee.com/link?target=https%3A%2F%2Fgithub.com%2Fjenkinsci%2Fgoogle-storage-plugin)，
-- [minio-storage-plugin](https://gitee.com/link?target=https%3A%2F%2Fgithub.com%2Fjenkinsci%2Fminio-storage-plugin)
+## 构建
 
+1.修改${USER}/.m2/settings.xml中的maven配置文件
+
+在`mirrors`节点中增加
+```xml
+<mirror>
+  <id>repo.jenkins-ci.org</id>
+  <url>https://repo.jenkins-ci.org/public/</url>
+  <mirrorOf>m.g.o-public</mirrorOf>
+</mirror>
+```
+在`pluginGroups`节点中增加
+```xml
+<pluginGroup>org.jenkins-ci.tools</pluginGroup>
+```
+在`profiles`节点中增加
+```xml
+<profile>
+  <id>jenkins</id>
+  <activation>
+    <activeByDefault>true</activeByDefault>
+  </activation>
+  <repositories>
+    <repository>
+      <id>repo.jenkins-ci.org</id>
+      <url>https://repo.jenkins-ci.org/public/</url>
+    </repository>
+  </repositories>
+  <pluginRepositories>
+    <pluginRepository>
+      <id>repo.jenkins-ci.org</id>
+      <url>https://repo.jenkins-ci.org/public/</url>
+    </pluginRepository>
+  </pluginRepositories>
+</profile>
+```
+
+2.打包
+```bash
+mvn clean package -DskipTests
+```
+
+3.运行
+```bash
+mvn clean hpi:run
+```
\ No newline at end of file
-- 
Gitee