Skip to content

Commit d6a39f0

Browse files
committed
Doc update
1 parent e07aaae commit d6a39f0

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

README.md

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

4-
## 3-minute Integration Guide
3+
Get your application events and errors to Trakerr via the *Trakerr API*.
4+
5+
You can send both errors and non-errors (plain log statements, for example) to Trakerr with this API.
6+
7+
## Overview
8+
9+
The **3-minute guide** is primarily oriented around sending errors or warnings and does not let you specify additional parameters.
10+
**Option-4 in the detailed integration guide** describes how you could send a non-error (or any log statement) along with additional parameters.
11+
12+
The SDK takes performance impact seriously and all communication between the SDK <=> Trakerr avoids blocking the calling function. The SDK also applies asynchronous patterns where applicable.
13+
14+
A Trakerr *Event* can consist of various parameters as described here in [TrakerrApi.AppEvent](https://github.com/trakerr-com/trakerr-javascript/blob/master/generated/docs/AppEvent.md).
15+
Some of these parameters are populated by default and others are optional and can be supplied by you.
16+
17+
Since some of these parameters are common across all event's, the API has the option of setting these on the
18+
TrakerrClient instance (described towards the bottom) and offers a factory API for creating AppEvent's.
19+
520
### Requirements
621
Node or Javascript supported Browser.
722
- [superagent.js](https://github.com/visionmedia/superagent)
823
- [stacktrace.js](https://www.stacktracejs.com/)
924

25+
## 3-minute Integration Guide
26+
1027
### HTML/Javascript: 3-minute guide
1128
Include the following in your HTML
1229

@@ -202,19 +219,18 @@ Name | Type | Description | Notes
202219
## Documentation for AppEvent
203220
- [TrakerrApi.AppEvent](https://github.com/trakerr-com/trakerr-javascript/blob/master/generated/docs/AppEvent.md)
204221

205-
## Developer dependencies
206-
- [grunt.js](https://gruntjs.com/) (if you want to build from source)
222+
## Developer Notes
223+
224+
**Dependencies:** [grunt.js](https://gruntjs.com/) (if you want to build from source)
207225

208-
## Installation via NPM
226+
**Installation via NPM:**
209227
To install off a branch which may have experimental features, you can use:
210228

211229
```bash
212230
npm install --only=prod --save trakerr-com/trakerr-javascript#<branch name>
213231
```
214-
without the angle brackets.
215232

216-
## Building from Source
217-
If you want to build from source for the browser, use the following command:
233+
**Building from Source:** If you want to build from source for the browser, use the following command:
218234

219235
```bash
220236
npm install [--save] trakerr-com/trakerr-javascript

0 commit comments

Comments
 (0)