Skip to content

Commit b267c6a

Browse files
committed
Update README.md
Updated requirements section.
1 parent 13dfeaf commit b267c6a

File tree

1 file changed

+5
-18
lines changed

1 file changed

+5
-18
lines changed

README.md

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# Trakerr - Javascript API Client
22
Get your application events and errors to Trakerr via the *Trakerr API
33

4-
## 3-minute Integration Guide
4+
## Requirements
5+
Node or Javascript supported Browser.
6+
[superagent.js](https://github.com/visionmedia/superagent)
7+
[stacktrace.js](https://www.stacktracejs.com/)
58

9+
## 3-minute Integration Guide
610
### HTML/Javascript: 3-minute guide
711
Include the following in your HTML
812

@@ -16,7 +20,6 @@ Include the following in your HTML
1620
This will catch all errors using javascript's onerror and send them to trakerr. While this code is useful, we recommend using the Detailed Integration Guide below to send more useful information about errors.
1721

1822
### NodeJS: 3-minute guide
19-
2023
If you use NPM, install as follows:
2124
```bash
2225
npm install --only=prod --save trakerr-io/trakerr-javascript
@@ -70,15 +73,6 @@ angular.module('your app').factory('$exceptionHandler', ['$window', function ($w
7073
## Detailed Integration Guide
7174
This library works with both node apps and browser apps seamlessly.
7275

73-
### Frameworks Supported
74-
- Javascript/JQuery
75-
- Nodejs
76-
- Angular
77-
78-
### Dependencies
79-
- [superagent.js](https://github.com/visionmedia/superagent)
80-
- [stacktrace.js](https://www.stacktracejs.com/)
81-
8276
For node apps just installing the above dependencies and bootstrapping the code similar to the below is sufficient. See the instructions below for the browser.
8377

8478
### Create a client
@@ -186,15 +180,8 @@ Name | Type | Description | Notes
186180

187181

188182
## Documentation for AppEvent
189-
190183
- [TrakerrApi.AppEvent](https://github.com/trakerr-io/trakerr-javascript/blob/master/generated/docs/AppEvent.md)
191184

192-
## API Version:
193-
- API version: 2.0.0
194-
- SDK version: 1.0.2
195-
196-
# Developer guide
197-
198185
## Developer dependencies
199186
- [grunt.js](https://gruntjs.com/) (if you want to build from source)
200187

0 commit comments

Comments
 (0)