From 185949c3fa704166ab802be9dc809e77a5e13758 Mon Sep 17 00:00:00 2001 From: Ben Gourley Date: Fri, 12 Jan 2018 15:38:16 +0000 Subject: [PATCH] Readme tweaks --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1f0d55b..676c26b 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ npm install --save-dev webpack-bugsnag-plugins const { BugsnagBuildReporterPlugin } = require('webpack-bugsnag-plugins') ``` -## `BugsnagBuildReporterPlugin(build, opts): stream` +### `BugsnagBuildReporterPlugin(build, opts): stream` Reports your application's build to Bugsnag. It can auto detect source control from `.git`, `.hg` and `package.json`. This plugin hooks into the `'after-emit'` event once all output files have been generated by the Webpack compiler. If anything causes the compilation to fail before this step, the build report will not get sent. @@ -37,7 +37,7 @@ This plugin hooks into the `'after-emit'` event once all output files have been - `path: string` the path to search for source control info, defaults to `process.cwd()` - `endpoint: string` post the build payload to a URL other than the default (`https://build.bugsnag.com`) -### Usage +#### Usage ```js const { BugsnagBuildReporterPlugin } = require('webpack-bugsnag-plugins')