Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ItalyPaleAle committed Dec 9, 2023
1 parent 5bb0a59 commit 02be8f4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 6 additions & 2 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 02be8f4

Please sign in to comment.