1
1
<!-- DO NOT EDIT, THIS FILE WAS GENERATED BY '../../scripts/generate-readmes.sh' -->
2
- <h1 align =" center " >
3
- <img align =" top " width =" 44 " src =" https://raw.githubusercontent.com/wxt-dev/wxt/HEAD/docs/public/hero-logo.svg " alt =" WXT Logo " >
4
- <span >WXT</span >
5
- </h1 >
6
-
7
- <p align =" center " >
8
- <a href =" https://www.npmjs.com/package/wxt " target =" _blank " ><img alt =" npm version " src =" https://img.shields.io/npm/v/wxt?labelColor=black&color=%234fa048 " ></a >
9
- <span > </span >
10
- <a href =" https://www.npmjs.com/package/wxt " target =" _blank " ><img alt =" downloads " src =" https://img.shields.io/npm/dm/wxt?labelColor=black&color=%234fa048 " ></a >
11
- <span > </span >
12
- <a href =" https://github.com/wxt-dev/wxt/blob/main/LICENSE " target =" _blank " ><img alt =" license | MIT " src =" https://img.shields.io/npm/l/wxt?labelColor=black&color=%234fa048 " ></a >
13
- <span > </span >
14
- <a href =" https://codecov.io/github/wxt-dev/wxt " target =" _blank " ><img alt =" coverage " src =" https://img.shields.io/codecov/c/github/wxt-dev/wxt?labelColor=black&color=%234fa048 " ></a >
15
- </p >
16
-
17
- <p align =" center " >
18
- <span >Next-gen framework for developing web extensions.</span >
19
- <br />
20
- <span >⚡</span >
21
- <br />
22
- <q ><i >It's like Nuxt, but for Web Extensions</i ></q >
23
- </p >
24
-
25
- <p align =" center " >
26
- <a href =" https://wxt.dev/guide/installation.html " target =" _blank " >Get Started</a >
27
- &bull ;
28
- <a href =" https://wxt.dev/api/config.html " target =" _blank " >Configuration</a >
29
- &bull ;
30
- <a href =" https://wxt.dev/examples.html " target =" _blank " >Examples</a >
31
- &bull ;
32
- <a href =" https://github.com/wxt-dev/wxt/blob/main/packages/wxt/CHANGELOG.md " target =" _blank " >Changelog</a >
33
- &bull ;
34
- <a href =" https://discord.gg/ZFsZqGery9 " target =" _blank " >Discord</a >
35
- </p >
2
+ <div align =" center " >
3
+
4
+ # <img align =" top " width =" 44 " src =" https://raw.githubusercontent.com/wxt-dev/wxt/HEAD/docs/public/hero-logo.svg " alt =" WXT Logo " > WXT
5
+
6
+ [ ![ npm version] ( https://img.shields.io/npm/v/wxt?labelColor=black&color=%234fa048 )] ( https://www.npmjs.com/package/wxt )
7
+ [ ![ downloads] ( https://img.shields.io/npm/dm/wxt?labelColor=black&color=%234fa048 )] ( https://www.npmjs.com/package/wxt )
8
+ [ ![ license | MIT] ( https://img.shields.io/npm/l/wxt?labelColor=black&color=%234fa048 )] ( https://github.com/wxt-dev/wxt/blob/main/LICENSE )
9
+ [ ![ coverage] ( https://img.shields.io/codecov/c/github/wxt-dev/wxt?labelColor=black&color=%234fa048 )] ( https://codecov.io/github/wxt-dev/wxt )
10
+
11
+ Next-gen framework for developing web extensions.<br />⚡<br /><q ><i >It's like Nuxt, but for Web Extensions</i ></q >
12
+
13
+ [ Get Started] ( https://wxt.dev/guide/installation.html ) •
14
+ [ Configuration] ( https://wxt.dev/api/config.html ) •
15
+ [ Examples] ( https://wxt.dev/examples.html ) •
16
+ [ Changelog] ( https://github.com/wxt-dev/wxt/blob/main/packages/wxt/CHANGELOG.md ) •
17
+ [ Discord] ( https://discord.gg/ZFsZqGery9 )
18
+
19
+ </div >
36
20
37
21
![ Example CLI Output] ( https://raw.githubusercontent.com/wxt-dev/wxt/HEAD/docs/assets/cli-output.png )
38
22
39
23
## Demo
40
24
41
- https://github.com/wxt-dev/wxt/assets/10101283/4d678939-1bdb-495c-9c36-3aa281d84c94
25
+ < https://github.com/wxt-dev/wxt/assets/10101283/4d678939-1bdb-495c-9c36-3aa281d84c94 >
42
26
43
27
## Quick Start
44
28
45
29
Bootstrap a new project:
46
30
47
- <!-- automd:pm-x version="latest" name="wxt" args="init" -->
48
-
49
31
``` sh
50
32
# npm
51
33
npx wxt@latest init
@@ -57,8 +39,6 @@ pnpm dlx wxt@latest init
57
39
bunx wxt@latest init
58
40
```
59
41
60
- <!-- /automd -->
61
-
62
42
Or see the [ installation guide] ( https://wxt.dev/guide/installation.html ) to get started with WXT.
63
43
64
44
## Features
@@ -80,17 +60,11 @@ Or see the [installation guide](https://wxt.dev/guide/installation.html) to get
80
60
81
61
WXT is a [ MIT-licensed] ( https://github.com/wxt-dev/wxt/blob/main/LICENSE ) open source project with its ongoing development made possible entirely by the support of these awesome backers. If you'd like to join them, please consider [ sponsoring WXT's development] ( https://github.com/sponsors/wxt-dev ) .
82
62
83
- < a href = " https://github.com/sponsors/wxt-dev " >< img alt = " WXT Sponsors " src = " https://raw.githubusercontent.com/wxt-dev/static/refs/heads/main/sponsorkit/sponsors.svg " ></ a >
63
+ [ ![ WXT Sponsors] ( https://raw.githubusercontent.com/wxt-dev/static/refs/heads/main/sponsorkit/sponsors.svg )] ( https://github.com/sponsors/wxt-dev )
84
64
85
65
## Contributors
86
66
87
- <!-- automd:contributors author="aklinker1" license="MIT" github="wxt-dev/wxt" -->
88
-
89
67
Published under the [ MIT] ( https://github.com/wxt-dev/wxt/blob/main/LICENSE ) license.
90
68
Made by [ @aklinker1 ] ( https://github.com/aklinker1 ) and [ community] ( https://github.com/wxt-dev/wxt/graphs/contributors ) 💛
91
- <br ><br >
92
- <a href =" https://github.com/wxt-dev/wxt/graphs/contributors " >
93
- <img src =" https://contrib.rocks/image?repo=wxt-dev/wxt " />
94
- </a >
95
69
96
- <!-- /automd -->
70
+ [ ![ WXT contributors ] ( https://contrib.rocks/image?repo=wxt-dev/wxt )] ( https://github.com/wxt-dev/wxt/graphs/contributors )
0 commit comments