Skip to content

Commit dd10080

Browse files
added readmes
1 parent 6b588bb commit dd10080

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed

packages/angularjs/README.md

Whitespace-only changes.

packages/core/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Exceptionless Core
2+
3+
This package is the main source of methods that inform all of the other Exceptionless JS packages. It should not be used directly. Instead, you should use one of the following pagages:
4+
5+
`@exceptionless/browser`
6+
`@exceptionless/node`
7+
`@exceptionless/react`
8+
`@exceptionless/angular`
9+

packages/node/README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## Exceptionless NodeJS
2+
3+
Using Exceptionless in the NodeJS environment is similar to using it in other JavaScript environments.
4+
5+
### Installation
6+
7+
Using npm:
8+
9+
`npm i @exceptionless/node`
10+
11+
Using yarn:
12+
13+
`yarn add @exceptionless/node`
14+
15+
### Configuration
16+
17+
When your NodeJS app starts up, it should tell the Exceptionless client to startup like this:
18+
19+
```js
20+
await Exceptionless.startup(c => {
21+
c.apiKey = "LhhP1C9gijpSKCslHHCvwdSIz298twx271n1l6xw";
22+
c.serverUrl = "http://localhost:5000";
23+
c.useDebugLogger();
24+
25+
c.defaultTags.push("Example", "Node");
26+
27+
// set some default data
28+
c.defaultData["SampleUser"] = {
29+
id: 1,
30+
name: "Blake",
31+
password: "123456",
32+
passwordResetToken: "a reset token",
33+
myPasswordValue: "123456",
34+
myPassword: "123456",
35+
customValue: "Password",
36+
value: {
37+
Password: "123456"
38+
}
39+
};
40+
});
41+
```
42+
43+
Once that's done, you can use the Exceptionless client anywhere in your app by calling `Exceptionless` followed by the method you want to use. For example:
44+
45+
```js
46+
Exceptionless.submitLog("Hello, world");
47+
```
48+
49+
### Using With Express
50+
51+
When using this package with an Express server, you should call `exceptionless.startup()` when the server starts. There are many ways to do this, but it's important that the client is instantiated before the server is used.

0 commit comments

Comments
 (0)