Skip to content

Commit fd7a092

Browse files
authored
chore(sveltekit): Update README (stable, wizard, links) (#8070)
1 parent 6462e0d commit fd7a092

File tree

2 files changed

+17
-11
lines changed

2 files changed

+17
-11
lines changed

packages/svelte/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
[![npm dm](https://img.shields.io/npm/dm/@sentry/svelte.svg)](https://www.npmjs.com/package/@sentry/svelte)
1111
[![npm dt](https://img.shields.io/npm/dt/@sentry/svelte.svg)](https://www.npmjs.com/package/@sentry/svelte)
1212

13-
This SDK currently only supports [Svelte](https://svelte.dev/) and is not yet fully compatible with with [SvelteKit](https://kit.svelte.dev/). If you would like the SDK to be fully compatible with SvelteKit, please reach out to us on [GitHub](https://github.com/getsentry/sentry-javascript/discussions/5838).
13+
This SDK currently only supports [Svelte](https://svelte.dev/) apps in the browser.
14+
If you're using SvelteKit, we recommend using our dedicated [Sentry SvelteKit SDK](https://github.com/getsentry/sentry-javascript/tree/develop/packages/sveltekit).
1415

1516
## General
1617

packages/sveltekit/README.md

+15-10
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,33 @@
1010
[![npm dm](https://img.shields.io/npm/dm/@sentry/sveltekit.svg)](https://www.npmjs.com/package/@sentry/sveltekit)
1111
[![npm dt](https://img.shields.io/npm/dt/@sentry/sveltekit.svg)](https://www.npmjs.com/package/@sentry/sveltekit)
1212

13-
<!--
14-
TODO: No docs yet, comment back in once we have docs
1513
## Links
1614

1715
- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/sveltekit/)
18-
- [TypeDoc](http://getsentry.github.io/sentry-javascript/) -->
19-
20-
## SDK Status
21-
22-
This SDK is currently in **Beta state**. Bugs and issues might still appear and we're still actively working
23-
on the SDK. Also, we're still adding features.
24-
If you experience problems or have feedback, please open a [GitHub Issue](https://github.com/getsentry/sentry-javascript/issues/new/choose).
2516

2617
## Compatibility
2718

2819
Currently, the minimum supported version of SvelteKit is `1.0.0`.
20+
The SDK works best with Vite 4.2 and newer.
21+
Older Vite versions might not generate source maps correctly.
2922

3023
## General
3124

3225
This package is a wrapper around `@sentry/node` for the server and `@sentry/svelte` for the client side, with added functionality related to SvelteKit.
3326

34-
## Setup
27+
## Automatic Setup
28+
29+
We recommend installing the SDK by running the [Sentry wizard](https://docs.sentry.io/platforms/javascript/guides/sveltekit/#install) in the root directory of your project:
30+
31+
```sh
32+
npx @sentry/wizard@latest -i sveltekit
33+
```
34+
35+
Take a look at the sections below if you want to customize your SDK configuration.
36+
37+
## Manual Setup
38+
39+
If the setup through the wizard doesn't work for you, you can also set up the SDK manually.
3540

3641
### 1. Prerequesits & Installation
3742

0 commit comments

Comments
 (0)