|
| 1 | +<h1 align="center"> |
| 2 | + <img style="vertical-align:middle" width="44" src="./docs/public/hero-logo.svg" alt="WXT Logo"> |
| 3 | + <span>WXT</span> |
| 4 | +</h1> |
| 5 | + |
| 6 | +<p align="center"> |
| 7 | + <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> |
| 8 | + <span> </span> |
| 9 | + <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> |
| 10 | + <span> </span> |
| 11 | + <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> |
| 12 | + <span> </span> |
| 13 | + <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> |
| 14 | +</p> |
| 15 | + |
| 16 | +<p align="center"> |
| 17 | + <span>Next-gen framework for developing web extensions.</span> |
| 18 | + <br/> |
| 19 | + <span>⚡</span> |
| 20 | + <br/> |
| 21 | + <q><i>It's like Nuxt, but for Chrome Extensions</i></q> |
| 22 | +</p> |
| 23 | + |
| 24 | +<p align="center"> |
| 25 | + <a href="https://wxt.dev" target="_blank">Get Started</a> |
| 26 | + • |
| 27 | + <a href="https://wxt.dev/guide/installation.html" target="_blank">Installation</a> |
| 28 | + • |
| 29 | + <a href="https://wxt.dev/api/config.html" target="_blank">Configuration</a> |
| 30 | + • |
| 31 | + <a href="https://wxt.dev/examples.html" target="_blank">Examples</a> |
| 32 | + • |
| 33 | + <a href="https://discord.gg/ZFsZqGery9" target="_blank">Discord</a> |
| 34 | +</p> |
| 35 | + |
| 36 | + |
| 37 | + |
| 38 | +## Demo |
| 39 | + |
| 40 | +https://github.com/wxt-dev/wxt/assets/10101283/4d678939-1bdb-495c-9c36-3aa281d84c94 |
| 41 | + |
| 42 | +## Quick Start |
| 43 | + |
| 44 | +Bootstrap a new project: |
| 45 | + |
| 46 | +```sh |
| 47 | +pnpm dlx wxt@latest init <project-name> |
| 48 | +``` |
| 49 | + |
| 50 | +Or see the [installation guide](https://wxt.dev/guide/installation.html) to get started with WXT. |
| 51 | + |
| 52 | +## Features |
| 53 | + |
| 54 | +- 🌐 Supports all browsers |
| 55 | +- ✅ Supports both MV2 and MV3 |
| 56 | +- ⚡ Dev mode with HMR & fast reload |
| 57 | +- 📂 File based entrypoints |
| 58 | +- 🚔 TypeScript |
| 59 | +- 🦾 Auto-imports |
| 60 | +- 🤖 Automated publishing |
| 61 | +- 🎨 Frontend framework agnostic: works with Vue, React, Svelte, etc |
| 62 | +- 🖍️ Quickly bootstrap a new project |
| 63 | +- 📏 Bundle analysis |
| 64 | +- ⬇️ Download and bundle remote URL imports |
| 65 | + |
| 66 | +## Contributors |
| 67 | + |
| 68 | +<a href="https://github.com/wxt-dev/wxt/graphs/contributors"> |
| 69 | + <img src="https://contrib.rocks/image?repo=wxt-dev/wxt" /> |
| 70 | +</a> |
0 commit comments