Skip to content

Commit 29994d8

Browse files
committed
docs: update docs & fix repo link
1 parent 3294a56 commit 29994d8

File tree

2 files changed

+35
-4
lines changed

2 files changed

+35
-4
lines changed

README.md

+31
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,33 @@
22

33
This is a compression plugin for vite. Use node stream.
44

5+
## Install
6+
7+
```bash
8+
9+
$ yarn add vite-compression-plugin -D
10+
11+
# or
12+
13+
$ npm install vite-compression-plugin -D
14+
15+
```
16+
17+
## Usage
18+
19+
```js
20+
import { defineConfig } from 'vite'
21+
22+
import Compression from 'vite-compression-plugin'
23+
24+
export default defineConfig({
25+
plugins: [
26+
// ...your plugin
27+
Compression()
28+
]
29+
})
30+
```
31+
532
## Options
633

734
| params | type | default | description |
@@ -20,3 +47,7 @@ This is a compression plugin for vite. Use node stream.
2047
## Author
2148

2249
Kanno
50+
51+
```
52+
53+
```

package.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "vite-compression-plugin",
3-
"version": "0.0.1",
3+
"version": "0.0.2",
44
"description": "compress souce file by stream, use it in vite.",
55
"main": "dist/vite-compression-plugin.cjs.js",
66
"types": "dist/vite-compression-plugin.d.ts",
@@ -15,15 +15,15 @@
1515
],
1616
"repository": {
1717
"type": "git",
18-
"url": "git+https://github.com/XeryYue/k.git"
18+
"url": "git+https://github.com/XeryYue/vite-compression-plugin.git"
1919
},
2020
"keywords": [],
2121
"author": "Kanno",
2222
"license": "MIT",
2323
"bugs": {
24-
"url": "https://github.com/XeryYue/k/issues"
24+
"url": "https://github.com/XeryYue/vite-compression-plugin/issues"
2525
},
26-
"homepage": "https://github.com/XeryYue/k#readme",
26+
"homepage": "https://github.com/XeryYue/vite-compression-plugin#readme",
2727
"devDependencies": {
2828
"@microsoft/api-extractor": "^7.19.4",
2929
"@rollup/plugin-node-resolve": "^13.1.3",

0 commit comments

Comments
 (0)