Skip to content

Commit 1c11af6

Browse files
mattdyoungmattdyoung
committed
Link to the official docs rather than duplicating instructions which may go out of date
1 parent 0406afb commit 1c11af6

File tree

4 files changed

+27
-86
lines changed

4 files changed

+27
-86
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Use the following plugins and guides to integrate Bugsnag with various framework
5454

5555
* Check out the [FAQ](https://docs.bugsnag.com/platforms/javascript/faq) and [configuration options](https://docs.bugsnag.com/platforms/javascript/configuration-options)
5656
* [Search open and closed issues](https://github.com/bugsnag/bugsnag-js/issues?q=+) for similar problems
57-
* [Report a bug or request a feature](https://github.com/bugsnag/bugsnag-js/issues/new)
57+
* [Report a bug or request a feature](https://github.com/bugsnag/bugsnag-js/issues/new/choose)
5858

5959
## Contributing
6060

‎packages/plugin-angular/README.md

+9-35
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,20 @@ This package enables you to integrate Bugsnag's error reporting with an Angular
66

77
Reported errors will contain useful debugging info from Angular's internals, such as the component and context.
88

9-
## Installation
9+
## Getting started
1010

11-
```sh
12-
npm i --save @bugsnag/js @bugsnag/plugin-angular
13-
# or
14-
yarn add @bugsnag/js @bugsnag/plugin-angular
15-
```
16-
17-
## Usage
18-
19-
In your the root of your angular app, typically `app.module.ts`:
20-
21-
```typescript
22-
// Import bugsnag-js and @bugsnag/plugin-angular
23-
import { BugsnagErrorHandler } from '@bugsnag/plugin-angular'
24-
import Bugsnag from 'bugsnag-js'
25-
26-
// configure Bugsnag ASAP, before any other imports
27-
Bugsnag.start('API_KEY')
28-
29-
// create a factory which will return the Bugsnag error handler
30-
export function errorHandlerFactory() {
31-
return new BugsnagErrorHandler()
32-
}
33-
34-
import { ErrorHandler, NgModule } from '@angular/core'
35-
// ... other imports omitted for brevity
36-
37-
@NgModule({
38-
/* Pass the BugsnagErrorHandler class along to the providers for your module */
39-
providers: [ { provide: ErrorHandler, useFactory: errorHandlerFactory } ]
40-
/* other properties passed to the decorator omitted for brevity */
41-
})
42-
```
11+
1. [Create a Bugsnag account](https://www.bugsnag.com)
12+
2. Complete the instructions in the [integration guide](https://docs.bugsnag.com/platforms/javascript/angular/)
13+
3. Report handled exceptions using
14+
[`Bugsnag.notify()`](https://docs.bugsnag.com/platforms/javascript/angular/#reporting-handled-errors)
15+
4. Customize your integration using the
16+
[configuration options](https://docs.bugsnag.com/platforms/javascript/angular/configuration-options/)
4317

4418
## Support
4519

46-
* Check out the [documentation](https://docs.bugsnag.com/platforms/browsers/)
20+
* Check out the [documentation](https://docs.bugsnag.com/platforms/javascript/angular/)
4721
* [Search open and closed issues](https://github.com/bugsnag/bugsnag-js/issues?q=is%3Aissue) for similar problems
48-
* [Report a bug or request a feature](https://github.com/bugsnag/bugsnag-js/issues/new)
22+
* [Report a bug or request a feature](https://github.com/bugsnag/bugsnag-js/issues/new/choose)
4923

5024
## License
5125

‎packages/plugin-react/README.md

+9-32
Original file line numberDiff line numberDiff line change
@@ -11,43 +11,20 @@ This package enables you to integrate Bugsnag's error reporting with React's [er
1111

1212
Reported errors will contain useful debugging info from Reacts's internals such as the component name where the error originated, and the component stack.
1313

14-
## Installation
15-
16-
```sh
17-
npm i --save @bugsnag/js @bugsnag/plugin-react
18-
# or
19-
yarn add @bugsnag/js @bugsnag/plugin-react
20-
```
21-
22-
## Usage
23-
24-
Depending on how your application is structured, usage differs slightly:
25-
26-
```js
27-
// initialize bugsnag ASAP, before other imports
28-
import Bugsnag from '@bugsnag/js'
29-
Bugsnag.start('API_KEY')
30-
31-
import ReactDOM from 'react-dom'
32-
import React from 'react'
33-
import bugsnagReact from '@bugsnag/plugin-react'
34-
Bugsnag.use(bugsnagReact, React)
35-
36-
// wrap your entire app tree in the ErrorBoundary provided
37-
const ErrorBoundary = Bugsnag.getPlugin('react');
38-
ReactDOM.render(
39-
<ErrorBoundary>
40-
<YourApp />
41-
</ErrorBoundary>,
42-
document.getElementById('app')
43-
)
44-
```
14+
## Getting started
15+
16+
1. [Create a Bugsnag account](https://www.bugsnag.com)
17+
2. Complete the instructions in the [integration guide](https://docs.bugsnag.com/platforms/javascript/react/)
18+
3. Report handled exceptions using
19+
[`Bugsnag.notify()`](https://docs.bugsnag.com/platforms/javascript/react/#reporting-handled-errors)
20+
4. Customize your integration using the
21+
[configuration options](https://docs.bugsnag.com/platforms/javascript/react/configuration-options/)
4522

4623
## Support
4724

4825
* Check out the [documentation](https://docs.bugsnag.com/platforms/javascript/react)
4926
* [Search open and closed issues](https://github.com/bugsnag/bugsnag-js/issues?q=is%3Aissue) for similar problems
50-
* [Report a bug or request a feature](https://github.com/bugsnag/bugsnag-js/issues/new)
27+
* [Report a bug or request a feature](https://github.com/bugsnag/bugsnag-js/issues/new/choose)
5128

5229
## License
5330

‎packages/plugin-vue/README.md

+8-18
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,20 @@ This package enables you to integrate Bugsnag's error reporting with a Vue.js ap
88

99
Reported errors will contain useful debugging info from Vue's internals, such as the component name, props and any other context that Vue can provide.
1010

11-
## Installation
11+
## Getting started
1212

13-
```sh
14-
npm i --save @bugsnag/js @bugsnag/plugin-vue
15-
# or
16-
yarn add @bugsnag/js @bugsnag/plugin-vue
17-
```
18-
19-
## Usage
20-
21-
```js
22-
const Vue = require('vue')
23-
const Bugsnag = require('@bugsnag/js')
24-
const bugsnagVue = require('@bugsnag/plugin-vue')
25-
26-
Bugsnag.start('API_KEY')
27-
Bugsnag.use(bugsnagVue, Vue)
28-
```
13+
1. [Create a Bugsnag account](https://www.bugsnag.com)
14+
2. Complete the instructions in the [integration guide](https://docs.bugsnag.com/platforms/javascript/vue/)
15+
3. Report handled exceptions using
16+
[`Bugsnag.notify()`](https://docs.bugsnag.com/platforms/javascript/vue/#reporting-handled-errors)
17+
4. Customize your integration using the
18+
[configuration options](https://docs.bugsnag.com/platforms/javascript/vue/configuration-options/)
2919

3020
## Support
3121

3222
* Check out the [documentation](https://docs.bugsnag.com/platforms/javascript/vue/)
3323
* [Search open and closed issues](https://github.com/bugsnag/bugsnag/js/issues?q=is%3Aissue) for similar problems
34-
* [Report a bug or request a feature](https://github.com/bugsnag/bugsnag/js/issues/new)
24+
* [Report a bug or request a feature](https://github.com/bugsnag/bugsnag/js/issues/new/choose)
3525

3626
## License
3727

0 commit comments

Comments
 (0)