diff --git a/README.md b/README.md new file mode 100644 index 00000000..d5e2c825 --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +

+ WXT Logo + WXT +

+ +

+ npm + + npm + + NPM + + Codecov +

+ +

+ Next-gen framework for developing web extensions. +
+ +
+ It's like Nuxt, but for Chrome Extensions +

+ +

+ Get Started + • + Installation + • + Configuration + • + Examples + • + Discord +

+ +![Example CLI Output](./docs/assets/cli-output.png) + +## Demo + +https://github.com/wxt-dev/wxt/assets/10101283/4d678939-1bdb-495c-9c36-3aa281d84c94 + +## Quick Start + +Bootstrap a new project: + +```sh +pnpm dlx wxt@latest init +``` + +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 +- 🤖 Automated publishing +- 🎨 Frontend framework agnostic: works with Vue, React, Svelte, etc +- 🖍️ Quickly bootstrap a new project +- 📏 Bundle analysis +- ⬇️ Download and bundle remote URL imports + +## Contributors + + + +