Skip to content

Commit b532311

Browse files
Lms24mydea
andauthored
chore(sveltekit): Update adapter compatibility in Readme (#8272)
Update the readme now that we're compatible with more adapters than just the Node adapter. Co-authored-by: Francesco Novy <[email protected]>
1 parent 1df2367 commit b532311

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

packages/sveltekit/README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,19 @@
1616

1717
## Compatibility
1818

19-
Currently, the minimum supported version of SvelteKit is `1.0.0`.
19+
The minimum supported version of SvelteKit is `1.0.0`.
2020
The SDK works best with Vite 4.2 and newer.
2121
Older Vite versions might not generate source maps correctly.
2222

23+
The SDK supports the following SvelteKit adapters:
24+
- `@sveltejs/adapter-auto` - for Vercel with the Node runtime. Other deployment targets might work but we don't guarantee compatibility.
25+
- `@sveltejs/adapter-vercel` - only for Node (Lambda) runtimes, not yet Vercel's edge runtime
26+
- `@sveltejs/adapter-node`
27+
28+
If you use the SDK with other adapters, we cannot guarantee that everything works as expected.
29+
You might need to [manually configure source maps upload](#-configuring-source-maps-upload).
30+
The SDK is currently not compatible with none-Node server runtimes, such as Vercel's Edge runtime or Cloudflare workers.
31+
2332
## General
2433

2534
This package is a wrapper around `@sentry/node` for the server and `@sentry/svelte` for the client side, with added functionality related to SvelteKit.
@@ -40,9 +49,7 @@ If the setup through the wizard doesn't work for you, you can also set up the SD
4049

4150
### 1. Prerequesits & Installation
4251

43-
1. Ensure you've set up the [`@sveltejs/adapter-node` adapter](https://kit.svelte.dev/docs/adapter-node)
44-
45-
2. Install the Sentry SvelteKit SDK:
52+
1. Install the Sentry SvelteKit SDK:
4653

4754
```bash
4855
# Using npm
@@ -310,12 +317,3 @@ export const load = wrapServerLoadWithSentry((event) => {
310317
});
311318
```
312319

313-
314-
## Known Limitations
315-
316-
This SDK is still under active development.
317-
Take a look at our [SvelteKit SDK Development Roadmap](https://github.com/getsentry/sentry-javascript/issues/6692) to follow the progress.
318-
319-
- **Adapters** other than `@sveltejs/adapter-node` are currently not supported.
320-
We haven't yet tested other platforms like Vercel.
321-
This is on our roadmap but it will come at a later time.

0 commit comments

Comments
 (0)