From 02be8f464493bb58ccab2084164a8710dddbe719 Mon Sep 17 00:00:00 2001 From: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com> Date: Sat, 9 Dec 2023 10:28:56 -0800 Subject: [PATCH] Updated docs --- README.md | 2 +- UPGRADING.md | 8 ++++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c124844..6a0d26d 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ More information can be found on the [template's repo](https://github.com/italyp ## Using svelte-spa-router -You can include the router in any project using Svelte 4. +You can include the router in any project using Svelte 3 or 4. ### Install from NPM diff --git a/UPGRADING.md b/UPGRADING.md index 0939f7e..831c8c2 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -15,9 +15,13 @@ When upgrading from svelte-spa-router 3.x to 4.x, please note the following breaking changes: -### Works with Svelte 4 +> svelte-spa-router 4.x is designed to work with Svelte 3 and 4. -svelte-spa-router 4.x is designed to work with Svelte 4. +### `wrap` method must be imported from `svelte-spa-router/wrap` + +The deprecated `wrap` method exported by `svelte-spa-router` has been removed and replaced with an import from `svelte-spa-router/wrap`. + +See [New `wrap` method](#new-wrap-method) for upgrade instructions. ## Upgrading to 3.x