Skip to content

Commit e8b4d65

Browse files
lesbaaLes Moffat
andauthored
RD-872 Update Readme with info regarding Svelte v4 and peerDeps (#88)
Co-authored-by: Les Moffat <[email protected]>
1 parent 0c47136 commit e8b4d65

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ Geocoding control is also provided as [React component](https://docs.maptiler.co
3636

3737
Install the Geocoding control unsing `npm`:
3838

39+
**⚠️ Warning! ⚠️**
40+
41+
The current version of Geocoding Control is only compatible with Svelte v4, this will potentially cause peer dependency issues when installing with certain versions of npm in Svelte projects (eg if you're using Svelte v5), or if you intend to import the Svelte component directly.
42+
43+
If you are using a this library in a Svelte project you can npm install with `--force` or `--legacy-peer-deps` and use only the **pre-compiled `GeoLocatControl` vanilla module**, not the Svelte component.
44+
3945
```shell
4046
npm install --save @maptiler/geocoding-control @maptiler/sdk
4147
```

0 commit comments

Comments
 (0)