docs(readme): 更新文档

Author: aliothor

.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: release-please
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        with:
+          release-type: node
+          package-name:
+            mtk-tool
+      - uses: actions/checkout@v3
+        if: ${{ steps.release.outputs.release_created }}
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: 'https://registry.npmjs.org'
+        if: ${{ steps.release.outputs.release_created }}
+      - run: |
+          npm install
+          npm run build
+        if: ${{ steps.release.outputs.release_created }}
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+        if: ${{ steps.release.outputs.release_created }}

README.md

@@ -7,25 +7,22 @@
   <a href="https://www.npmjs.com/package/vite-plugin-ol-external" target="_blank">
     <img alt="downloads" src="https://img.shields.io/npm/dt/vite-plugin-ol-external.svg?style=flat">
   </a>
-  <a href="https://github.com/vitejs/awesome-vite#helpers" target="_blank">
-    <img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome">
-  </a>
 </p>
 
 external openlayers plugin for vite
 
 Can be used in `production` mode without other `rollup` configuration.
 
-## Usage
+## 📘 Usage
 
 ```bash
-npm i vite-plugin-ol-external -D
+pnpm add vite-plugin-ol-external -D
 ```
 
-Add it to `vite.config.js`
+Add it to `vite.config.ts`
 
-```js
-// vite.config.js
+```ts
+// vite.config.ts
 import { viteExternalOlPlugin } from 'vite-plugin-ol-external'
 
 export default {
@@ -35,7 +32,7 @@ export default {
 }
 ```
 
-## How to work
+## 🔨 How to work
 
 transform source code of js file.
 
@@ -70,7 +67,7 @@ export default {
 
 If an error occurs, you can check whether the error is caused by the plugin order.
 
-## Configuration
+## 📜 Configuration
 
 ### disableInServe
 
@@ -106,3 +103,6 @@ const Map = ol.Map
 ### sourceMapOptions
 
 The configuration item of the code sourcemap after code conversion. The library is `magic-string`.
+
+## 💖 reference
+> [vite-plugin-externals](https://github.com/crcong/vite-plugin-externals)

package.json

@@ -47,7 +47,7 @@
     "bumpp": "^9.2.0",
     "eslint": "^8.51.0",
     "rimraf": "^5.0.5",
-    "rollup": "^4.1.0",
+    "rollup": "^4.1.4",
     "typescript": "^5.2.2",
     "vite": "^4.4.11",
     "vitest": "^0.34.6"

pnpm-lock.yaml

@@ -10,7 +10,7 @@
     "strict": true,
     "moduleResolution": "Node",
     "esModuleInterop": true,
-    "types": ["node", "vitest/globals"]
+    "types": ["vitest/globals"]
   },
   "files": [
     "./src/index.ts"