From 71626740fdb4073072d5362a76b3d9776b496a94 Mon Sep 17 00:00:00 2001 From: Aaron Date: Sat, 4 Jan 2025 19:41:27 -0600 Subject: [PATCH] docs: Add note about WXT to README --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index cab4b534..4bb64f8a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ +> [!IMPORTANT] +> `vite-plugin-web-extension` will soon be deprecated in favor of [WXT](https://wxt.dev), it's successor. While WXT is still in pre-release, it already supports everything this plugin does, [is significantly more popular](https://api.star-history.com/svg?repos=wxt-dev/wxt,aklinker1/vite-plugin-web-extension&type=Date), and includes more features and bug fixes that aren't (and won't) be added to `vite-plugin-web-extension`. +> +> If you're starting a new project, I'd recommend you [use WXT instead](https://wxt.dev/guide/installation.html#bootstrap-project). Once WXT v1.0 is released within the next few months, [I'll provide a more in-depth migration guide](https://wxt.dev/guide/resources/migrate.html#vite-plugin-web-extension) for existing projects and `vite-plugin-web-extension` will enter maintainence mode. + ![Build Status](https://img.shields.io/github/actions/workflow/status/aklinker1/vite-plugin-web-extension/pr-checks.yml) ![NPM Version](https://img.shields.io/npm/v/vite-plugin-web-extension) ![NPM Downloads](https://img.shields.io/npm/dm/vite-plugin-web-extension) ![Vite Version](https://img.shields.io/npm/dependency-version/vite-plugin-web-extension/peer/vite)