@dobeacon/sdk 0.0.0-stage → 2.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/LICENSE +15 -0
- package/README.md +51 -2
- package/dist/dobeacon.cjs +5247 -0
- package/dist/dobeacon.esm.js +5197 -0
- package/dist/dobeacon.min.js +1 -0
- package/package.json +45 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
Copyright (c) 2026 FJM Consulting LLC (DoBeacon). All rights reserved.
|
|
2
|
+
|
|
3
|
+
This package is proprietary software. You may install it and use it unmodified
|
|
4
|
+
on websites and applications you operate, only to connect them to your own
|
|
5
|
+
DoBeacon account, and only while you are bound by the DoBeacon Terms of Service
|
|
6
|
+
(https://dobeacon.com/terms).
|
|
7
|
+
|
|
8
|
+
You may not copy, modify, redistribute, sublicense or sell this software, or use
|
|
9
|
+
it to build a product that competes with DoBeacon, except as the Terms of
|
|
10
|
+
Service allow.
|
|
11
|
+
|
|
12
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
13
|
+
IMPLIED. TO THE EXTENT THE LAW ALLOWS, FJM CONSULTING LLC IS NOT LIABLE FOR ANY
|
|
14
|
+
CLAIM, DAMAGES OR OTHER LIABILITY ARISING FROM THE SOFTWARE OR ITS USE, EXCEPT
|
|
15
|
+
AS THE TERMS OF SERVICE PROVIDE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,52 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @dobeacon/sdk
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Guided tours, an in-page assistant and messages for your web app, powered by
|
|
4
|
+
[DoBeacon](https://dobeacon.com). Build tours in the DoBeacon dashboard or Chrome
|
|
5
|
+
extension; this package plays them on your site.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install @dobeacon/sdk
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Start
|
|
14
|
+
|
|
15
|
+
Call `init` once, in the browser, with your project key (Dashboard → your project →
|
|
16
|
+
Install). The key is public by design: it only reads published tours and posts events.
|
|
17
|
+
|
|
18
|
+
```js
|
|
19
|
+
import DoBeacon from '@dobeacon/sdk';
|
|
20
|
+
|
|
21
|
+
DoBeacon.init('pk_live_YOUR_KEY');
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
In Next.js or any server-rendered app, call it on the client only:
|
|
25
|
+
|
|
26
|
+
```js
|
|
27
|
+
if (typeof window !== 'undefined') {
|
|
28
|
+
DoBeacon.init(process.env.NEXT_PUBLIC_DOBEACON_KEY);
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Then, once your sign-in resolves, tell DoBeacon who the visitor is:
|
|
33
|
+
|
|
34
|
+
```js
|
|
35
|
+
DoBeacon.identify(user.id, { name: user.name, plan: user.plan });
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Prefer a script tag?
|
|
39
|
+
|
|
40
|
+
```html
|
|
41
|
+
<script src="https://dobeacon.com/v2/dobeacon.min.js" data-project-key="pk_live_YOUR_KEY" async></script>
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Docs
|
|
45
|
+
|
|
46
|
+
- [Install with npm](https://dobeacon.com/docs/npm)
|
|
47
|
+
- [SDK API](https://dobeacon.com/docs/sdk/api) · [Events](https://dobeacon.com/docs/sdk/events) · [Step types](https://dobeacon.com/docs/sdk/step-types)
|
|
48
|
+
|
|
49
|
+
## License
|
|
50
|
+
|
|
51
|
+
Proprietary. Use requires a DoBeacon account and is governed by the
|
|
52
|
+
[DoBeacon Terms of Service](https://dobeacon.com/terms). See `LICENSE`.
|