diff --git a/README.md b/README.md index 7835a268..35712452 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,25 @@ -# WXT +
Next gen framework for building web extensions. Powered by Vite.
## Features -- [x] Supports all browsers -- [x] MV2 & MV3 support -- [x] Directory based entrypoints -- [x] Virtual content script and background entryoints with default behaviors -- [ ] Great DX - - [x] Auto-imports - - [x] TypeScript, - - [x] HMR for HTML pages - - [ ] Auto-reload for background and content scripts -- [x] Unit and E2E tests -- [ ] Open browser during development with extension installed -- [x] Download and bundle remote dependencies -- [x] Supports all major frontend frameworks (Vue, React, Svelte) -- [ ] Automated publishing -- [ ] Project bootstrap -- [ ] Bundle analysis -- [ ] ~~_Infer permissions from code_~~ Maybe in the future... +- 🌐 Build for Chrome, Firefox, Edge, and Safari +- ✅ Supports both MV2 and MV3 +- 📂 Directory based entrypoints +- 🚔 TypeScript +- 🦾 Auto-imports +- ⚡ Dev mode with HMR +- ⬇️ Download and bundle remote URL imports +- 🎨 Supports all major frontend frameworks (Vue, React, Svelte) + +### Todo + +- 🤖 Automated publishing +- 🖍️ Quickly bootstrap a new project +- 📏 Bundle analysis +- ⚡ Dev mode with HMR and **_auto-reload_** + +## Get Started + +Checkout the [installation guide](https://wxtjs.dev/get-started) to get started with WXT.