diff --git a/packages/svelte/README.md b/packages/svelte/README.md index 4fb87a431787..5ea7bbed0fb8 100644 --- a/packages/svelte/README.md +++ b/packages/svelte/README.md @@ -10,7 +10,8 @@ [![npm dm](https://img.shields.io/npm/dm/@sentry/svelte.svg)](https://www.npmjs.com/package/@sentry/svelte) [![npm dt](https://img.shields.io/npm/dt/@sentry/svelte.svg)](https://www.npmjs.com/package/@sentry/svelte) -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). +This SDK currently only supports [Svelte](https://svelte.dev/) apps in the browser. +If you're using SvelteKit, we recommend using our dedicated [Sentry SvelteKit SDK](https://github.com/getsentry/sentry-javascript/tree/develop/packages/sveltekit). ## General diff --git a/packages/sveltekit/README.md b/packages/sveltekit/README.md index 3951ffcac04f..309b59fcd2ac 100644 --- a/packages/sveltekit/README.md +++ b/packages/sveltekit/README.md @@ -10,28 +10,33 @@ [![npm dm](https://img.shields.io/npm/dm/@sentry/sveltekit.svg)](https://www.npmjs.com/package/@sentry/sveltekit) [![npm dt](https://img.shields.io/npm/dt/@sentry/sveltekit.svg)](https://www.npmjs.com/package/@sentry/sveltekit) - - -## SDK Status - -This SDK is currently in **Beta state**. Bugs and issues might still appear and we're still actively working -on the SDK. Also, we're still adding features. -If you experience problems or have feedback, please open a [GitHub Issue](https://github.com/getsentry/sentry-javascript/issues/new/choose). ## Compatibility Currently, the minimum supported version of SvelteKit is `1.0.0`. +The SDK works best with Vite 4.2 and newer. +Older Vite versions might not generate source maps correctly. ## General This package is a wrapper around `@sentry/node` for the server and `@sentry/svelte` for the client side, with added functionality related to SvelteKit. -## Setup +## Automatic Setup + +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: + +```sh +npx @sentry/wizard@latest -i sveltekit +``` + +Take a look at the sections below if you want to customize your SDK configuration. + +## Manual Setup + +If the setup through the wizard doesn't work for you, you can also set up the SDK manually. ### 1. Prerequesits & Installation