diff --git a/packages/sveltekit/README.md b/packages/sveltekit/README.md index 48a13d757f48..21393e19c4e7 100644 --- a/packages/sveltekit/README.md +++ b/packages/sveltekit/README.md @@ -19,9 +19,9 @@ TODO: No docs yet, comment back in once we have docs ## 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). +This SDK is currently in **Alpha state** and we're still experimenting with APIs and functionality. +We therefore make no guarantees in terms of semver or breaking changes. +If you want to try this SDK and come across a problem, please open a [GitHub Issue](https://github.com/getsentry/sentry-javascript/issues/new/choose). ## Compatibility @@ -31,7 +31,11 @@ Currently, the minimum supported version of SvelteKit is `1.0.0`. 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 +## Usage + +Although the SDK is not yet stable, you're more than welcome to give it a try and provide us with early feedback. + +**Here's how to get started:** ### 1. Prerequesits & Installation @@ -254,7 +258,7 @@ export default { ## Known Limitations -This SDK is still under active development. +This SDK is still under active development and several features are missing. Take a look at our [SvelteKit SDK Development Roadmap](https://github.com/getsentry/sentry-javascript/issues/6692) to follow the progress: - **Adapters** other than `@sveltejs/adapter-node` are currently not supported.