Skip to content

Commit

Permalink
docs: explain this library in large projects (#667)
Browse files Browse the repository at this point in the history
  • Loading branch information
mentos1386 authored Feb 23, 2024
1 parent 84a66b1 commit 1c990ca
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ This is a [sentry](https://sentry.io/) module for [Nest](https://github.com/nest

This package is no longer based on deprecated raven module, but rather on new stable [@sentry/node](https://www.npmjs.com/package/@sentry/node) module.

#### Should i use this for large projects?

This is not a solution for all cases and large applications, just a quick starter that covers the common rest/graphql capturing (the basics).
You might want deeper integration with Sentry, which means you can still use this to cover the rest/graphql error capture, but you will have to use the rest of Sentry SDK to cover other cases.

For really large projects, you might have to take this library as an example of how to integrate sentry with NestJS, and write your custom integration instead.

## Installation

```bash
Expand Down

0 comments on commit 1c990ca

Please sign in to comment.