upload-assets-oss 0.0.1 → 0.0.3

package/README.md

@@ -1,16 +1,66 @@
-# Vue 3 + TypeScript + Vite
+# upload-assets-oss
 
-This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+将打包好的静态资源上传至对象存储服务，兼容vite与webpack。
 
-## Recommended IDE Setup
+## feature
 
-- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
+七牛云oss ✅
 
-## Type Support For `.vue` Imports in TS
+阿里云oss ❌
 
-Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's Take Over mode by following these steps:
+## 安装
 
-1. Run `Extensions: Show Built-in Extensions` from VS Code's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
-2. Reload the VS Code window by running `Developer: Reload Window` from the command palette.
+```sh
+npm install -D upload-assets-oss
 
-You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471).
+or 
+
+yarn add -D upload-assets-oss
+```
+
+## vite中使用
+
+```js
+import { vitePluginQiniu } from 'upload-assets-oss';
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [
+    vitePluginQiniu({ 
+      accessKey: '',
+      secretKey: '', 
+      bucket: '', 
+      forceDelete: true
+    }),
+  ],
+});
+```
+
+## webpack中使用
+
+```js
+import { WebpackPluginQiniu } from 'upload-assets-oss';
+
+// https://vitejs.dev/config/
+module.exports = {
+  plugins: [
+    new WebpackPluginQiniu({ 
+      accessKey: '',
+      secretKey: '', 
+      bucket: '', 
+      forceDelete: true
+    }),
+  ],
+};
+```
+
+## Options
+
+| Name | Type | Default| Required| Description |
+| --- | --- | --- | --- | --- |
+|  accessKey   |  string   |  ''   |   true  |  七牛 Access Key   |
+|  secretKey   |  string   |  ''  |  true   |  七牛 Secret Key   |
+|  bucket   |  string   |  ''   |   true  |  七牛 空间名   |
+|  forceDelete   |  boolean   |  false   |  false   |  上传文件前，先强制删除之前上传七牛云上的文件   |
+|  rootName   |  string   |  '项目名称'   |  false   |  文件上传的根目录名称  |
+|  isLog   |  boolean   |  false   |  false   |  是否打印上传日志   |

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "upload-assets-oss",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "type": "module",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
   "repository": {
     "type": "git",
-    "url": "https://github.com/jialongsu/vite-plugin-qiniu.git"
+    "url": "https://github.com/jialongsu/upload-assets-oss.git"
   },
   "bugs": {
-    "url": "https://github.com/jialongsu/vite-plugin-qiniu/issues"
+    "url": "https://github.com/jialongsu/upload-assets-oss/issues"
   },
-  "homepage": "https://github.com/jialongsu/vite-plugin-qiniu#readme",
+  "homepage": "https://github.com/jialongsu/upload-assets-oss#readme",
   "scripts": {
     "dev": "yarn build -- --watch --ignore-watch examples",
     "build": "tsup src/index.ts"