twd-js 1.3.0 → 1.3.2

package/README.md

@@ -147,9 +147,16 @@ Full documentation is available at [twd.dev](https://twd.dev) (coming soon) or i
 - [Writing Tests](docs/writing-tests.md)
 - [API Mocking](docs/api-mocking.md)
 
-## Why TWD?
+## Examples
 
-Check out the [examples directory](https://github.com/BRIKEV/twd/tree/main/examples) for complete working examples.
+Check out our working examples for various frameworks:
+
+- **[Examples Directory](./examples)** - Local examples for React, Vue, and Astro
+- **[Vue Example](https://github.com/BRIKEV/twd-vue-example)** - Vue 3 with advanced scenarios
+- **[Solid Example](https://github.com/BRIKEV/twd-solid-example)** - Solid.js integration
+- **[Angular Example](https://github.com/BRIKEV/twd-angular-example)** - Angular setup
+
+Each example includes a complete setup guide and demonstrates best practices for testing with TWD including ci integration.
 
 ## Contributing
 

package/dist/bundled.d.ts

@@ -4,6 +4,24 @@ interface TestModule {
 interface InitTWDOptions {
     open?: boolean;
     position?: "left" | "right";
+    serviceWorker?: boolean;
+    serviceWorkerUrl?: string;
 }
+/**
+ * Initialize TWD with tests and optional configuration
+ * @param files The test modules
+ * @param options The options for the initialization
+ * @param options.open Whether to open the sidebar
+ * @param options.position The position of the sidebar
+ * @param options.serviceWorker Whether to use the service worker
+ * @param options.serviceWorkerUrl The URL of the service worker
+ * @returns void
+ * @example
+ * initTWD(testModules, { open: true, position: 'left' });
+ * @example
+ * initTWD(testModules, { open: true, position: 'left', serviceWorker: false });
+ * @example
+ * initTWD(testModules, { open: true, position: 'left', serviceWorker: true, serviceWorkerUrl: '/mock-sw.js' });
+ */
 export declare const initTWD: (files: TestModule, options?: InitTWDOptions) => void;
 export {};