From e8b68e195cc423f9f4a72663b84e60f7ea2edea1 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Mon, 4 Jul 2022 14:04:38 +0200 Subject: [PATCH] docs(remix): Adjust wording in Remix README (#5357) --- packages/remix/README.md | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/packages/remix/README.md b/packages/remix/README.md index 5a8d22ba7db1..d3cd45a8efe2 100644 --- a/packages/remix/README.md +++ b/packages/remix/README.md @@ -11,7 +11,8 @@ [![npm dt](https://img.shields.io/npm/dt/@sentry/nextjs.svg)](https://www.npmjs.com/package/@sentry/remix) [![typedoc](https://img.shields.io/badge/docs-typedoc-blue.svg)](http://getsentry.github.io/sentry-javascript/) -This SDK is considering experimental and in an alpha state. It may experience breaking changes. Please reach out on [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback/concerns. +This SDK is considered experimental and in an alpha state. It may experience breaking changes. Please reach out on [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback/concerns. + ## General This package is a wrapper around `@sentry/node` for the server and `@sentry/react` for the client, with added functionality related to Remix. @@ -73,21 +74,21 @@ import { import { ErrorBoundary, withSentryRouteTracing } from "@sentry/remix"; function App() { - return ( - - - - - - - - - - - - - - + return ( + + + + + + + + + + + + + + ); } @@ -126,7 +127,7 @@ Sentry.captureEvent({ ## Sourcemaps and Releases -The Remix SDK provides a script that automatically creates a release and uploads sourcemaps. To generate sourcemaps with Remix, you need to call `remix build` with `--sourcemap` option. +The Remix SDK provides a script that automatically creates a release and uploads sourcemaps. To generate sourcemaps with Remix, you need to call `remix build` with the `--sourcemap` option. On release, call `sentry-upload-sourcemaps` to upload source maps and create a release. To see more details on how to use the command, call `sentry-upload-sourcemaps --help`.