Aaron Klinker
73 lines
2.3 KiB
Markdown
73 lines
2.3 KiB
Markdown
<h1 align="center">
|
|
<img style="vertical-align:middle" width="44" src="./docs/public/hero-logo.svg" alt="WXT Logo">
|
|
<span>WXT</span>
|
|
</h1>
|
|
|
|
<p align="center">
|
|
<a href="https://www.npmjs.com/package/wxt" target="_blank"><img alt="npm" src="https://img.shields.io/npm/v/wxt?labelColor=black&color=%234fa048"></a>
|
|
<span> </span>
|
|
<a href="https://www.npmjs.com/package/wxt" target="_blank"><img alt="npm" src="https://img.shields.io/npm/dm/wxt?labelColor=black&color=%234fa048"></a>
|
|
<span> </span>
|
|
<a href="https://github.com/wxt-dev/wxt/blob/main/LICENSE" target="_blank"><img alt="NPM" src="https://img.shields.io/npm/l/wxt?labelColor=black&color=%234fa048"></a>
|
|
<!-- Hide code coverage while it's broken -->
|
|
<!-- <span> </span>
|
|
<a href="https://codecov.io/github/wxt-dev/wxt" target="_blank"><img alt="Codecov" src="https://img.shields.io/codecov/c/github/wxt-dev/wxt?labelColor=black&color=%234fa048"></a> -->
|
|
</p>
|
|
|
|
<p align="center">
|
|
<span>Next-gen framework for developing web extensions.</span>
|
|
<br/>
|
|
<span>⚡</span>
|
|
<br/>
|
|
<q><i>It's like Nuxt, but for Chrome Extensions</i></q>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://wxt.dev" target="_blank">Get Started</a>
|
|
•
|
|
<a href="https://wxt.dev/guide/installation.html" target="_blank">Installation</a>
|
|
•
|
|
<a href="https://wxt.dev/api/config.html" target="_blank">Configuration</a>
|
|
•
|
|
<a href="https://wxt.dev/examples.html" target="_blank">Examples</a>
|
|
</p>
|
|
|
|
|
|
|
|
## Demo
|
|
|
|
https://github.com/wxt-dev/wxt/assets/10101283/07359e53-f491-43b6-8e8f-fae94aec8063
|
|
|
|
## Quick Start
|
|
|
|
Bootstrap a new project:
|
|
|
|
```sh
|
|
pnpx wxt@latest init <project-name>
|
|
```
|
|
|
|
Or see the [installation guide](https://wxt.dev/guide/installation.html) to get started with WXT.
|
|
|
|
## Features
|
|
|
|
- 🌐 Supports all browsers
|
|
- ✅ Supports both MV2 and MV3
|
|
- ⚡ Dev mode with HMR & fast reload
|
|
- 📂 File based entrypoints
|
|
- 🚔 TypeScript
|
|
- 🦾 Auto-imports
|
|
- ⬇️ Download and bundle remote URL imports
|
|
- 🎨 Frontend framework agnostic: works with Vue, React, Svelte, etc
|
|
- 🖍️ Quickly bootstrap a new project
|
|
- 📏 Bundle analysis
|
|
|
|
### Coming Soon
|
|
|
|
- 🤖 Automated publishing
|
|
|
|
## Contributors
|
|
|
|
<a href="https://github.com/wxt-dev/wxt/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=wxt-dev/wxt" />
|
|
</a>
|