Skip to content

Commit cbe8658

Browse files
committed
fix: docs updated
1 parent 441acb2 commit cbe8658

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @mk-singh/web-utils
1+
# [@mk-singh/utils](https://www.npmjs.com/package/@mk-singh/utils)
22

33
## Why This Library?
44

@@ -19,14 +19,14 @@ This library solves these problems by providing a declarative way to define your
1919
-**Next.js** (App Router & Pages Router)
2020
-**Vanilla JavaScript** (Framework agnostic)
2121
-**TypeScript** (Full type support)
22-
-**Any JavaScript bundler** (Webpack, Vite, Rollup, etc.)# @mk-singh/web-utils
22+
-**Any JavaScript bundler** (Webpack, Vite, Rollup, etc.)# @mk-singh/utils
2323

2424
A collection of JavaScript utility functions designed for modern web development, with special focus on React.js applications. Modular and tree-shakeable for optimal bundle sizes.
2525

2626
## Installation
2727

2828
```javascript
29-
import { createRoutes } from "@mk-singh/web-utils";
29+
import { createRoutes } from "@mk-singh/utils";
3030
```
3131

3232
## Modular Imports
@@ -35,7 +35,7 @@ Import only what you need to keep your bundle size small:
3535

3636
```javascript
3737
// Import specific utilities
38-
import { createRoutes } from "@mk-singh/web-utils/factories/route-factory";
38+
import { createRoutes } from "@mk-singh/utils/route-factory";
3939
```
4040

4141
## Features
@@ -60,7 +60,7 @@ Transforms a route configuration object into a fully resolved route structure wi
6060
```tsx
6161
import React from 'react';
6262
import { BrowserRouter, Routes, Route, Link } from 'react-router-dom';
63-
import { createRoutes } from "@mk-singh/web-utils/factories/route-factory";
63+
import { createRoutes } from "@mk-singh/utils/route-factory";
6464

6565
// Define your route configuration
6666
const routeConfig = {
@@ -83,7 +83,7 @@ const routeConfig = {
8383
step: 3,
8484
prevPath: "./user/settings",
8585
},
86-
};
86+
} as const;
8787

8888
// Generate routes with base path
8989
const routes = createRoutes("/app", routeConfig);
@@ -126,7 +126,7 @@ function Settings() {
126126
#### Basic Example
127127

128128
```javascript
129-
import { createRoutes } from "@mk-singh/web-utils/factories/route-factory";
129+
import { createRoutes } from "@mk-singh/utils/route-factory";
130130

131131
const routeConfig = {
132132
start: { path: "start" },
@@ -148,7 +148,7 @@ const routeConfig = {
148148
step: 3,
149149
prevPath: "./onboarding/businessDetails",
150150
},
151-
};
151+
} as const;
152152

153153
const routes = createRoutes("/client", routeConfig);
154154

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "@mk-singh/web-utils",
3-
"version": "1.0.0",
2+
"name": "@mk-singh/utils",
3+
"version": "0.1.1",
44
"type": "module",
55
"description": "A collection of TypeScript utilities for Deno including route factory with navigation support",
66
"author": {

0 commit comments

Comments
 (0)