Skip to content

Commit 99c068f

Browse files
committed
Update README.md
Update examples.
1 parent 887e2f8 commit 99c068f

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,12 @@ Include the following in your HTML
1414
<script src="https://cdnjs.cloudflare.com/ajax/libs/superagent/3.5.2/superagent.min.js"></script>
1515
<script src="https://cdnjs.cloudflare.com/ajax/libs/stacktrace.js/1.3.1/stacktrace.min.js"></script>
1616
<script src="https://cdn.jsdelivr.net/trakerr/1.0.2/trakerr.min.js"></script>
17-
<script>function initTrakerr() { var c = new TrakerrClient('<api-key>', '<version of your code>', '<deployment stage of codebase>'); c.handleExceptions(false); } initTrakerr();</script>
17+
<script>function initTrakerr() { var c = new TrakerrClient('<api-key>', '1.0', 'production'); c.handleExceptions(false); } initTrakerr();</script>
1818
```
1919

20-
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.
20+
You can replace `1.0` and `production` with the values of app version and deployment stage of your codebase.
21+
22+
This will catch all errors using javascript's onerror and send them to trakerr. While this code is fast and clean, we recommend using the Detailed Integration Guide below to send more useful information about errors.
2123

2224
### NodeJS: 3-minute guide
2325
If you use NPM, install as follows:
@@ -50,7 +52,10 @@ Include the dependencies and initialize the global client variable with your API
5052
<script src="https://cdnjs.cloudflare.com/ajax/libs/stacktrace.js/1.3.1/stacktrace.min.js"></script>
5153
<script src="https://cdn.jsdelivr.net/gh/trakerr-com/trakerr-javascript@1.1.0/dist/trakerr.min.js"></script>
5254
<!-- initialize the client globally -->
53-
<script> trakerr = new TrakerrClient('<api-key>', '<version of your code>', '<deployment stage of codebase>'); </script>
55+
<script> trakerr = new TrakerrClient('<api-key>', '<api-key>', //Your API key
56+
'<app version here>', //Your app version
57+
'<deployment stage here>'); //Custom deployment stage of your code.
58+
</script>
5459
```
5560

5661
And in the angular module, install an $exceptionHandler as shown below:

0 commit comments

Comments
 (0)