Skip to content

Commit 7c5d4d1

Browse files
committed
feat!: Deprecate @wjfe/n-savant as package
1 parent c2cf58d commit 7c5d4d1

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,36 @@
1-
# <img src="src/lib/logo/logo-48.svg" alt="N-Savant Logo" width="48" height="48" align="left">&nbsp;&nbsp;&nbsp;@wjfe/n-savant
1+
# <img src="src/lib/logo/logo-48.svg" alt="N-Savant Logo" width="48" height="48" align="left">&nbsp;&nbsp;@wjfe/n-savant
22

3-
> The client-side router for Svelte v5 SPA's that invented multi hash routing.
3+
> ⚠️ DEPRECATED
4+
>
5+
> This package has been deprecated because it has been renamed and re-branded. Use `@svelte-router/core` instead.
6+
7+
## 📦 Package Renaming & Deprecation Notice
8+
9+
The `@wjfe/n-savant` and `@wjfe/n-savant-sk` packages are now deprecated and will no longer receive updates. Please
10+
migrate to the new `@svelte-router/*` packages to ensure compatibility with future versions of Svelte.
11+
12+
### Migration Instructions
13+
14+
As of v1.0, the router has been renamed to better reflect its role in the Svelte ecosystem. Install the new package
15+
and update your imports:
16+
17+
| Old Package Path | New Package Path |
18+
|---------------------------|-------------------------------|
19+
| `@wjfe/n-savant` | `@svelte-router/core` |
20+
| `@wjfe/n-savant-sk` | `@svelte-router/kit` |
21+
| `@wjfe/n-savant/core` | `@svelte-router/core/kernel` |
22+
23+
---
424

525
[REPL Demo](https://svelte.dev/playground/d273d356947e48c0822a65402fd06fac)
626

27+
[Full Documentation @ Hashnode Space](https://wjfe-n-savant.hashnode.space)
28+
729
## Features
830

931
> **📝 Small and Unique!**
1032
>
11-
> + Less than **1,450** lines of code, including TypeScript typing.
33+
> + About **1,450** lines of code, including TypeScript typing.
1234
> + Always-on path and hash routing. Simultaneous and independent routing modes.
1335
> + The router that invented multi hash routing.
1436
> + **NEW!** Supports Sveltekit (via [@wjfe/n-savant-sk](https://github.com/WJSoftware/wjfe-n-savant-sk))

0 commit comments

Comments
 (0)