From 31abf94eb5e066d4b923f8580bddf6ddf938f028 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Peter=20B=C3=B8dskov?= Date: Mon, 13 Sep 2021 15:53:58 +0200 Subject: [PATCH] minor updates of README --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e652c44..d636e1b 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,10 @@ public func configure(_ app: Application) throws { ### Reporting -`BugsnagMiddleware` will automatically report errors thrown by your route handlers. You can report errors manually from `Application` or `Request`. +`BugsnagMiddleware` will automatically report errors thrown by your route handlers. If you do not want to report certain error types see [Controlling Your Error Reports](#controlling-your-error-reports). + +#### Manual Reporting +You can report errors manually from `Application` or `Request`. ```swift // Reporting from Application. @@ -50,7 +53,11 @@ app.get("test") { req in } ``` -By conforming to the `BugsnagError` protocol you can have full control over how your errors are reported. It has the following properties: +### Controlling Your Error Reports + +By conforming to the `BugsnagError` protocol you can have full control over how your errors are reported. + +It has the following properties: | Name | Type | Function | Default | |---|---|---|---| @@ -89,7 +96,7 @@ req.bugsnag.breadcrumb( ) ``` -The breadcrumb types are provided by Bugsnag: +Bugsnag provides the following breadcrumb types: ```swift enum BugsnagBreadcrumbType { @@ -121,7 +128,7 @@ In this case Bugsnag Reports will hide header fields, query params or post body ## 🏆 Credits -This package is developed and maintained by the Vapor team at [Nodes](https://www.nodesagency.com). +This package is developed and maintained by the Vapor team at [Monstarlab](https://monstar-lab.com/global/). ## 📄 License