@klime/node 1.2.1 → 1.3.0

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.
Files changed (2) hide show
  1. package/README.md +9 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -54,6 +54,15 @@ process.on("SIGTERM", async () => {
54
54
  });
55
55
  ```
56
56
 
57
+ ## Good to know
58
+
59
+ - **No anonymous tracking.** Every `track()` call needs a `userId` or `groupId`. Wait until the user is identified before sending events.
60
+ - **Name your events in past tense** with an Object + Action pattern: `"Report Generated"`, `"User Invited"`, `"Export Completed"`.
61
+ - **Always set `email` and `name` traits** in `identify()` and `group()`. These are used for display and search in the dashboard.
62
+ - **Traits can be strings, numbers, booleans, or ISO 8601 date strings.** Use camelCase for trait keys.
63
+ - **In Group mode, your dashboard stays empty until you call `group()`.** Events from `identify()` and `track()` are recorded, but customers won't appear until users are linked to groups.
64
+ - **Order doesn't matter.** Events sent before `identify()` or `group()` are retroactively attributed once the relationships are established.
65
+
57
66
  ## Installation Prompt
58
67
 
59
68
  Copy and paste this prompt into Cursor, Copilot, or your favorite AI editor to integrate Klime:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@klime/node",
3
- "version": "1.2.1",
3
+ "version": "1.3.0",
4
4
  "type": "module",
5
5
  "description": "Klime SDK for Node.js",
6
6
  "main": "dist/index.cjs",