Skip to content

Commit 32700a9

Browse files
update readme
1 parent 50409a0 commit 32700a9

File tree

1 file changed

+13
-28
lines changed

1 file changed

+13
-28
lines changed

README.md

+13-28
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,39 @@
1-
# unplugin-starter
1+
# Stencil Unplugin
22

3-
[![NPM version](https://img.shields.io/npm/v/unplugin-starter?color=a1b858&label=)](https://www.npmjs.com/package/unplugin-starter)
3+
[![NPM version](https://img.shields.io/npm/v/unplugin-stencil?color=a1b858&label=)](https://www.npmjs.com/package/unplugin-stencil)
44

5-
Starter template for [unplugin](https://github.com/unjs/unplugin).
6-
7-
## Template Usage
8-
9-
To use this template, clone it down using:
10-
11-
```bash
12-
npx degit unplugin/unplugin-starter my-unplugin
13-
```
14-
15-
And do a global replacement of `unplugin-starter` with your plugin name.
16-
17-
Then you can start developing your unplugin 🔥
18-
19-
To test your plugin, run: `pnpm run dev`
20-
To release a new version, run: `pnpm run release`
5+
An unplugin that wraps the [Stencil](https://stenciljs.com/) compiler to be used within Astro, Esbuild, Nuxt, Rollup, rspack, Vite and Webpack etc. environments.
216

227
## Install
238

9+
To install this unplugin, run:
10+
2411
```bash
25-
npm i unplugin-starter
12+
npm i unplugin-stencil
2613
```
2714

2815
<details>
2916
<summary>Vite</summary><br>
3017

3118
```ts
3219
// vite.config.ts
33-
import Starter from 'unplugin-starter/vite'
20+
import stencil from 'unplugin-stencil/vite'
3421

3522
export default defineConfig({
3623
plugins: [
37-
Starter({ /* options */ }),
24+
stencil({ /* Stencil configuration overwrites */ }),
3825
],
3926
})
4027
```
4128

42-
Example: [`playground/`](./playground/)
43-
4429
<br></details>
4530

4631
<details>
4732
<summary>Rollup</summary><br>
4833

4934
```ts
5035
// rollup.config.js
51-
import Starter from 'unplugin-starter/rollup'
36+
import Starter from 'unplugin-stencil/rollup'
5237

5338
export default {
5439
plugins: [
@@ -68,7 +53,7 @@ export default {
6853
module.exports = {
6954
/* ... */
7055
plugins: [
71-
require('unplugin-starter/webpack')({ /* options */ })
56+
require('unplugin-stencil/webpack')({ /* options */ })
7257
]
7358
}
7459
```
@@ -82,7 +67,7 @@ module.exports = {
8267
// nuxt.config.js
8368
export default defineNuxtConfig({
8469
modules: [
85-
['unplugin-starter/nuxt', { /* options */ }],
70+
['unplugin-stencil/nuxt', { /* options */ }],
8671
],
8772
})
8873
```
@@ -99,7 +84,7 @@ export default defineNuxtConfig({
9984
module.exports = {
10085
configureWebpack: {
10186
plugins: [
102-
require('unplugin-starter/webpack')({ /* options */ }),
87+
require('unplugin-stencil/webpack')({ /* options */ }),
10388
],
10489
},
10590
}
@@ -113,7 +98,7 @@ module.exports = {
11398
```ts
11499
// esbuild.config.js
115100
import { build } from 'esbuild'
116-
import Starter from 'unplugin-starter/esbuild'
101+
import Starter from 'unplugin-stencil/esbuild'
117102

118103
build({
119104
plugins: [Starter()],

0 commit comments

Comments
 (0)