diff --git a/examples/with-sentry/README.md b/examples/with-sentry/README.md index 7538b9057379a..1372909a5addd 100644 --- a/examples/with-sentry/README.md +++ b/examples/with-sentry/README.md @@ -1,8 +1,8 @@ # Sentry -_Note: `@sentry/nextjs` is not yet guaranteed to be compatible with the newly-released Next.js 12. This example therefore uses Next.js 11._ +_Note: Currently, the minimum Next.js supported version of `@sentry/nextjs` is 10.0.8._ -This is an example showing how to use [Sentry](https://sentry.io) to catch and report errors and monitor the performance of both the front and back ends, using the [official Sentry SDK for Next.js](https://docs.sentry.io/platforms/javascript/guides/nextjs/). +This is an example showing how to use [Sentry](https://sentry.io) to catch and report errors and monitor the performance of both the front and back ends, using the [official Sentry SDK for Next.js](https://docs.sentry.io/platforms/javascript/guides/nextjs/). This example contains the following: - `sentry.server.config.js` and `sentry.client.config.js` are used to configure and initialize Sentry - `next.config.js` automatically injects Sentry into your app using `withSentryConfig` @@ -47,6 +47,8 @@ Next, run [`sentry-wizard`](https://docs.sentry.io/platforms/javascript/guides/n npx @sentry/wizard -i nextjs ``` +_Beware that above command creates files extended with `.wizardcopy.js` as the example already contains the config files._ + Once the files are created, you can further configure your app by adding [SDK settings](https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/) to `sentry.server.config.js` and `sentry.client.config.js`, and [`SentryWebpackPlugin` settings](https://github.com/getsentry/sentry-webpack-plugin#options) to `next.config.js`. (If you'd rather do the SDK set-up manually, [you can do that, too](https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/).)