diff --git a/README.md b/README.md index 47116a8..9c27b21 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # nuxt-cos > [!WARNING] -> Experimental. The [Cross-Origin Storage API](https://github.com/WICG/cross-origin-storage) is an early-stage proposal with no native browser support yet, and the chunk format here is not stable. This is a research project, not a production tool. +> **Experimental**. The [Cross-Origin Storage API](https://github.com/WICG/cross-origin-storage) is an early-stage proposal with no native browser support yet, and the chunk format here is not stable. Load shared dependencies (such as `vue`) from [Cross-Origin Storage (COS)](https://github.com/WICG/cross-origin-storage). @@ -18,6 +18,8 @@ Most sites ship their own copy of common dependencies, and the browser re-downlo This is exploratory. The Cross-Origin Storage API is a [WICG proposal](https://github.com/WICG/cross-origin-storage) with no native browser implementation; today it only works via the [browser extension](https://github.com/web-ai-community/cross-origin-storage-extension). Without COS the loader falls back to ordinary network requests, so builds keep working everywhere. +The idea is that this enables testing and early feedback for the proposal. + The plugin builds on [Thomas Steiner](https://github.com/tomayac)'s original [`vite-plugin-cross-origin-storage`](https://github.com/tomayac/vite-plugin-cross-origin-storage) and is intended as an update of it, with the aim of merging back upstream. ## 🚧 Roadmap @@ -26,17 +28,8 @@ The plugin builds on [Thomas Steiner](https://github.com/tomayac)'s original [`v - [ ] Opting transitive dependencies out of COS chunking. - [ ] Automatic detection of [allow-listed dependencies](https://github.com/tomayac/public-hash-list). -## Development - -```bash -pnpm install -pnpm build # build all packages -pnpm test # run unit + e2e tests -pnpm lint -``` - -The e2e tests will run a real browser with and without the [Cross-Origin Storage extension](https://chromewebstore.google.com/detail/cross-origin-storage/denpnpcgjgikjpoglpjefakmdcbmlgih). The COS-extension tests need a full Chrome for Testing build (`npx playwright-core install chromium`) and clone the extension at test time; set `COS_SKIP_EXTENSION_TEST=1` only in an environment that genuinely cannot run a headed browser. - ## License -[MIT](./LICENSE) +Made with ❤️ + +Published under [MIT License](./LICENSE).