@enhance-eng/sandbox 0.3.10 → 0.3.17-dev.7469ea2

package/README.md

@@ -0,0 +1,44 @@
+# @enhance-eng/sandbox
+
+Enhance sandbox library for adding preview functionality to your application.
+
+**Supported frameworks:** React SPAs and statically generated sites. SSR is not supported.
+
+## Installation
+
+```bash
+npm install @enhance-eng/sandbox
+```
+
+## Vite
+
+Add the plugin to your Vite config:
+
+```typescript
+// vite.config.ts
+import { enhance } from "@enhance-eng/sandbox/vite";
+
+export default defineConfig({
+  plugins: [enhance()],
+});
+```
+
+That's it. The plugin handles everything automatically.
+
+## Other Build Tools
+
+For non-Vite setups, use the CLI to copy the required assets to your public directory:
+
+```bash
+npx enhance-sandbox prepare-sw --public-dir ./public
+```
+
+Then initialize Enhance in your application entry point:
+
+```typescript
+import { Enhance } from "@enhance-eng/sandbox";
+
+Enhance.init();
+```
+
+Run the CLI as part of your build process to keep assets up to date.