From ab85867f610c1f2cc896a5b39097010e5187ba6c Mon Sep 17 00:00:00 2001
From: joshbalfour <joshbalfour@users.noreply.github.com>
Date: Wed, 1 May 2024 13:28:58 +0000
Subject: [PATCH] Apply readme changes

---
 packages/modules/sentry/readme.md | 48 ++++++++++++++++++++++++++++++-
 readme.md                         |  4 +--
 2 files changed, 49 insertions(+), 3 deletions(-)

diff --git a/packages/modules/sentry/readme.md b/packages/modules/sentry/readme.md
index 8bc590c..e3441df 100644
--- a/packages/modules/sentry/readme.md
+++ b/packages/modules/sentry/readme.md
@@ -3,7 +3,7 @@
 
 ![npm version](https://img.shields.io/npm/v/@reapit-cdk/sentry)
 ![npm downloads](https://img.shields.io/npm/dm/@reapit-cdk/sentry)
-![coverage: 85.39%25](https://img.shields.io/badge/coverage-85.39%25-green)
+![coverage: 78.02%25](https://img.shields.io/badge/coverage-78.02%25-orange)
 
 Minimal Sentry SDK
 
@@ -13,4 +13,50 @@ Minimal Sentry SDK
 yarn add --dev @reapit-cdk/sentry
 # or
 npm install @reapit-cdk/sentry --save-dev
+```
+
+## Usage
+```ts
+// for usage with Edge API SDK
+// { sentryDsn: string; sentryRelease: string } is required to be in your request env
+import { initSentryLogger } from '@reapit-cdk/sentry/dist/edge-api-sentry-logger'
+import { JSONResponse, jsonRequestHandler } from '@reapit-cdk/edge-api-sdk'
+
+export const handler = jsonRequestHandler<{ sentryDsn: string; sentryRelease: string }>(
+  async (): Promise<JSONResponse<{ something: string }>> => {
+    return {
+      body: {
+        something: 'important',
+      },
+    }
+  },
+  (request) => ({
+    loggerConfig: {
+      transports: [initSentryLogger(request)],
+    },
+  }),
+)
+
+// for browser usage
+import { initBrowserSentry } from '@reapit-cdk/sentry/dist/browser'
+
+initBrowserSentry({
+  componentName: '',
+  dsn: '',
+  environment: '',
+  release: '',
+  sessionId: '',
+})
+
+// for browser usage, with breadcrumb integration
+import { initBreadcrumbIntegration } from '@reapit-cdk/sentry/dist/browser-breadcrumb-integration'
+initBrowserSentry({
+  componentName: '',
+  dsn: '',
+  environment: '',
+  release: '',
+  sessionId: '',
+  integrations: [initBreadcrumbIntegration],
+})
+
 ```
\ No newline at end of file
diff --git a/readme.md b/readme.md
index 22b088d..703e55a 100644
--- a/readme.md
+++ b/readme.md
@@ -1,5 +1,5 @@
 # @reapit-cdk/ts-constructs
-![coverage: 90.32%25](https://img.shields.io/badge/coverage-90.32%25-green)
+![coverage: 88.39%25](https://img.shields.io/badge/coverage-88.39%25-green)
 CDK Constructs Monorepo
 ## Constructs
 
@@ -153,7 +153,7 @@ Types for @reapit-cdk/email-receiver and client.
 
 ![npm version](https://img.shields.io/npm/v/@reapit-cdk/sentry)
 ![npm downloads](https://img.shields.io/npm/dm/@reapit-cdk/sentry)
-![coverage: 85.39%25](https://img.shields.io/badge/coverage-85.39%25-green)
+![coverage: 78.02%25](https://img.shields.io/badge/coverage-78.02%25-orange)
 
 Minimal Sentry SDK