navilo 1.2.1 → 1.2.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Zubeyr Anwar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -4,20 +4,13 @@
 ![License](https://img.shields.io/npm/l/navilo)
 ![TypeScript](https://img.shields.io/badge/TypeScript-%3E%3D5.0-blue)
 
-**File-based routing plugin for Vite + React applications**
+**A Vite plugin that adds file-based routing to React apps by wrapping React Router (peer dependency)**
 
 ---
 
 ## Installation
 
 ```bash
-# Using npm
-npm install navilo
-
-# Using yarn
-yarn add navilo
-
-# Using pnpm
 pnpm add navilo
 ```
 
@@ -39,6 +32,15 @@ Navilo automatically generates a route tree from your `src/app` (or custom) dire
 
 ### Vite Config
 
+1. Install react router dom since its our peer dependency
+
+```bash
+npm install react-router-dom@6.16.0
+
+```
+
+2.Add the navilo to plugin in vite config
+
 ```ts
 // vite.config.ts
 import {defineConfig} from 'vite';
@@ -55,6 +57,30 @@ export default defineConfig({
 });
 ```
 
+3. Add this vite-env.d.ts
+
+```ts
+/// <reference types="vite/client" />
+declare module 'virtual:navilo-routes' {
+    export const router;
+}
+```
+
+4. Now import the router from virtual module
+
+```tsx
+import {RouterProvider} from "react-router-dom";
+import {router} from 'virtual:preluder-routes';
+
+export function App() {
+    return (
+        <RouterProvider router={router}/>
+    );
+}
+```
+
+5. 🎉 Volla now you can now use it like next js
+
 ### Directory Structure Example
 
 ```
@@ -170,19 +196,5 @@ const routeTree = routeTreeBuilder.build(routes, {
 | `error`     | Error page for nested layouts      |
 | `not-found` | 404 page                           |
 
----
-
-## Example React Router Usage
-
-```tsx
-import {RouterProvider} from "react-router-dom";
-import {router} from 'virtual:preluder-routes';
-
-export function App() {
-    return (
-        <RouterProvider router={router}/>
-    );
-}
-```
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "navilo",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "File-based routing plugin for Vite + React applications",
   "main": "dist/index.js",
   "module": "dist/index.mjs",