twd-js 1.3.0-beta.2 → 1.3.1

package/README.md

@@ -36,27 +36,34 @@ pnpm add twd-js
 
 ## Quick Start
 
-1. **Add TWD to your React app:**
+### React (Standard)
 
-```tsx
-// src/main.tsx
-import { StrictMode } from "react";
-import { createRoot } from "react-dom/client";
-import App from "./App";
+Add this to your entry file (e.g., `src/main.tsx`):
 
+```tsx
 if (import.meta.env.DEV) {
   const testModules = import.meta.glob("./**/*.twd.test.ts");
   const { initTests, twd, TWDSidebar } = await import('twd-js');
   initTests(testModules, <TWDSidebar open={true} position="left" />, createRoot);
   twd.initRequestMocking().catch(console.error);
 }
+```
 
-createRoot(document.getElementById("root")!).render(
-  <StrictMode><App /></StrictMode>
-);
+### Vue / Angular / Other Frameworks (Bundled)
+
+TWD now supports any framework via its bundled version.
+
+```ts
+if (import.meta.env.DEV) {
+  const { initTWD } = await import('twd-js/bundled');
+  const tests = import.meta.glob("./**/*.twd.test.ts");
+  initTWD(tests);
+}
 ```
 
-2. **Write your first test:**
+Check the [Framework Integration Guide](https://brikev.github.io/twd/frameworks) for more details.
+
+## Writing Tests
 
 ```ts
 // src/app.twd.test.ts
@@ -131,17 +138,25 @@ twd.mockRequest("getUser", {
 const rule = await twd.waitForRequest("getUser");
 ```
 
-## Learn More
+## Documentation
 
-- 📖 **[Full Documentation](https://brikev.github.io/twd/)** - Complete guides and tutorials
-- 🎯 **[Writing Tests](https://brikev.github.io/twd/writing-tests)** - Learn how to write effective tests
-- 🔥 **[API Mocking](https://brikev.github.io/twd/api-mocking)** - Mock API requests in your tests
-- 📚 **[API Reference](https://brikev.github.io/twd/api/)** - Complete API documentation
-- 🧪 **[Testing Library Support](https://brikev.github.io/twd/react-testing-library)** - Use semantic queries
+Full documentation is available at [twd.dev](https://twd.dev) (coming soon) or in the `docs` folder.
+
+- [Getting Started](docs/getting-started.md)
+- [Framework Integration](docs/frameworks.md)
+- [Writing Tests](docs/writing-tests.md)
+- [API Mocking](docs/api-mocking.md)
 
 ## 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