@fixflow/sdk 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,6 +10,16 @@ Lightweight error capture SDK for Node.js and browser environments.
|
|
|
10
10
|
npm install @fixflow/sdk
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
+
## Project Key
|
|
14
|
+
|
|
15
|
+
The `PROJECT_KEY` is a unique identifier that connects your application to your FixFlow project.
|
|
16
|
+
|
|
17
|
+
**Where to find it:**
|
|
18
|
+
1. Sign in to your [FixFlow Dashboard](https://tryfixflow.com).
|
|
19
|
+
2. Create a project (or select an existing one).
|
|
20
|
+
3. (Optional) Connect your repository if you want FixFlow to scan your code for issues and security vulnerabilities.
|
|
21
|
+
4. Your **SDK Project Key** is displayed in the project header and under the **SDK Settings** tab in Project Details.
|
|
22
|
+
|
|
13
23
|
## Usage
|
|
14
24
|
|
|
15
25
|
```ts
|
|
@@ -64,6 +74,16 @@ export function FixFlowInit() {
|
|
|
64
74
|
|
|
65
75
|
Mount that component once near the root of your tree. Next.js App Router users can wrap it in a small client component used from the root layout.
|
|
66
76
|
|
|
77
|
+
### React Native
|
|
78
|
+
|
|
79
|
+
Call `init` at the very **top of your entry file** (usually `App.js` or `index.js`) before your component definition to capture startup errors:
|
|
80
|
+
|
|
81
|
+
```ts
|
|
82
|
+
import fixflow from "@fixflow/sdk";
|
|
83
|
+
|
|
84
|
+
fixflow.init("PROJECT_KEY");
|
|
85
|
+
```
|
|
86
|
+
|
|
67
87
|
### Node.js
|
|
68
88
|
|
|
69
89
|
Call `init` **once at process startup** (for example at the top of `server.ts`, before creating or listening on your HTTP server):
|