next-vite-router 1.0.2 → 1.0.3

package/README.md

@@ -59,6 +59,21 @@ Notes:
 - The plugin default `pagesDir` is `src/app`. You can change it via options.
 - The virtual module is `virtual:next-vite-router` (the plugin resolves it internally).
 
+TypeScript note:
+
+If you're using TypeScript in a consuming project, add a declaration file so the virtual module is recognized by the compiler. Create a file such as `src/virtual.d.ts` (or any `*.d.ts` included by your `tsconfig.json`) with the following content:
+
+```ts
+declare module 'virtual:next-vite-router' {
+  import type { RouteObject } from 'react-router-dom';
+
+  export const generateRoutes: () => RouteObject[];
+  export { useRoutes } from 'react-router-dom';
+}
+```
+
+This ensures TypeScript knows the shape of the virtual module provided by the Vite plugin and avoids `Cannot find module 'virtual:next-vite-router'` errors in editors and builds.
+
 ## Programmatic route generation
 
 If you prefer to generate routes manually (for custom setups), the package exports helpers you can use with `import.meta.glob`.
@@ -153,25 +168,6 @@ The plugin takes an options object. Defaults are:
 
 Pass a custom `pagesDir` if your project uses `src/pages` or another convention.
 
-## Examples & Demos
-
-If you want, I can add a small demo app showing:
-
-- A minimal `src/pages` layout with nested layouts
-- How `generateRoutes()` maps files to React Router routes
-- A Vite dev server example showing HMR for page/layout changes
-
-Tell me which example you'd prefer and I will scaffold it.
-
-## Contributing
-
-Contributions welcome. Suggested workflow:
-
-1. Fork the repo
-2. Create a branch
-3. Run `pnpm install` and `pnpm run dev` to test locally
-4. Open a PR with description and tests/examples if applicable
-
 ## License
 
-MIT
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-vite-router",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Next.js-like file-based routing for React + Vite",
   "type": "module",
   "main": "./dist/index.js",