添加包说明

README.md

@@ -1,3 +1,46 @@
 # upload_sdk
 
-上传插件，不包含上传的前端实现，只提供后端接口等，其他地方接入插件上传。包括上传进度、断点续传等
+上传插件，不包含上传的前端实现，只提供后端接口等，其他地方接入插件上传。包括上传进度、断点续传等
+
+## 使用方法
+
+### 在 package.json 里添加 
+```
+"upload_sdk": "git+ssh://git@git.links123.net:npm/upload_sdk.git"
+```
+
+### 在文件中引入
+
+```
+import UploadSdk from 'upload_sdk'
+
+```
+
+### 初始化传入 host(api)， origin(社区 'forum')， token， file
+```
+let uploadSdk = new UploadSdk(host,origin,token,file)
+```
+
+### 主要方法
+```
+//上传图片，默认实现断点续传，如果上次上传中断，第二次上传如果服务器那边还没过期会接着上传
+uploadSdk.imageUploadAction().then((res) => {
+      const { url } = res
+      this.updateFileList(file, url)
+    }).catch((err) => {
+      console.log(err)
+})
+
+//上传视频
+uploadSdk.videoUploadAction().then((res) => {
+      const { url } = res
+      this.updateFileList(file, url)
+    }).catch((err) => {
+      console.log(err)
+})
+
+//监听上传进度，用于有显示上传进度条的需求
+uploadSdk.onUpdateProgress( progress => {
+      console.log(progress)
+})
+```