@jasolar/tracker-sdk 1.0.3 → 1.0.4

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 CHANGED
@@ -14,9 +14,41 @@
14
14
  ## 安装
15
15
 
16
16
  ```bash
17
- npm install tracker-sdk
17
+ npm install @jasolar/tracker-sdk
18
18
  ```
19
19
 
20
+ ## 本地测试
21
+
22
+ 在发布到 npm 之前,你可以在本地 Vue3/React 项目中测试 SDK:
23
+
24
+ ### 方式一:使用 npm link(推荐)
25
+
26
+ ```bash
27
+ # 在 tracker-sdk 项目中
28
+ yarn build
29
+ npm link
30
+
31
+ # 在你的 Vue3 项目中
32
+ npm link @jasolar/tracker-sdk
33
+ ```
34
+
35
+ ### 方式二:使用 yalc(更稳定)
36
+
37
+ ```bash
38
+ # 安装 yalc
39
+ npm install -g yalc
40
+
41
+ # 在 tracker-sdk 项目中
42
+ yarn build
43
+ yalc publish
44
+
45
+ # 在你的 Vue3 项目中
46
+ yalc add @jasolar/tracker-sdk
47
+ yarn install
48
+ ```
49
+
50
+ 详细测试指南请查看 [LOCAL_TEST.md](./LOCAL_TEST.md)
51
+
20
52
  ## 快速上手
21
53
 
22
54
  ### 1. 基本使用
@@ -36,21 +68,19 @@ tracker.setUser('user-123');
36
68
 
37
69
  ### 2. 使用插件
38
70
  ```javascript
39
- import { performancePlugin } from 'tracker-sdk';
40
- import { errorPlugin } from 'tracker-sdk';
41
- import { routerPlugin } from 'tracker-sdk';
42
- import { autoTracker } from 'tracker-sdk';
43
-
44
- tracker.use(performancePlugin());
45
- tracker.use(errorPlugin());
46
- tracker.use(routerPlugin());
47
- tracker.use(autoTracker());
71
+ import { performancePlugin, errorPlugin, routerPlugin, autoTracker } from '@jasolar/tracker-sdk';
72
+
73
+ tracker.use(performancePlugin);
74
+ tracker.use(errorPlugin);
75
+ tracker.use(routerPlugin);
76
+ tracker.use(autoTracker);
48
77
  ```
49
78
 
50
79
  ### 3. 在页面中实现 track
51
80
  ```javascript
52
- import { tracker } from 'tracker-sdk';
81
+ import { getTracker } from '@jasolar/tracker-sdk';
53
82
 
83
+ const tracker = getTracker();
54
84
  tracker.enter({
55
85
  system: 'dashboard', // 系统
56
86
  module: 'energy', // 模块