@fuul/sdk 0.5.0 → 0.5.1
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 +7 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,23 +2,23 @@
|
|
|
2
2
|
|
|
3
3
|
**Setting up the Fuul SDK**
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## 1. Install the Fuul SDK
|
|
6
6
|
|
|
7
7
|
Run one of the following commands to add Fuul SDK to your project:
|
|
8
8
|
|
|
9
9
|
### npm
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
npm install fuul
|
|
12
|
+
npm install @fuul/sdk
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
### yarn
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
|
-
yarn add fuul
|
|
18
|
+
yarn add @fuul/sdk
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
## 2
|
|
21
|
+
## 2. Set up the Fuul SDK
|
|
22
22
|
|
|
23
23
|
In order to authenticate to full with your project, you must execute the following in the root file of your app.
|
|
24
24
|
|
|
@@ -37,7 +37,7 @@ By this way, you’ll be available to use Fuul as a global object in any of your
|
|
|
37
37
|
|
|
38
38
|
- Please note that `projectId` is not required when you initialize Fuul sdk, but it is mandatory in order to send a `“connect_wallet”` event. But don’t worry, you can send it later as an argument using the `Fuul.sendEvent()` method if needed (please refer to section 3 of this guide)
|
|
39
39
|
|
|
40
|
-
## 3
|
|
40
|
+
## 3. Verifying the connection to Fuul SDK
|
|
41
41
|
|
|
42
42
|
You can verify that everything was set up successfully with the following method
|
|
43
43
|
|
|
@@ -49,7 +49,7 @@ If everything is ok, you will see a prompt as below:
|
|
|
49
49
|
|
|
50
50
|
|
|
51
51
|
|
|
52
|
-
## 4
|
|
52
|
+
## 4. Sending events
|
|
53
53
|
|
|
54
54
|
In order to send events such as `pageview` or `connect_wallet` you must do the following
|
|
55
55
|
|
|
@@ -83,7 +83,7 @@ const handlePageView = async () => {
|
|
|
83
83
|
}
|
|
84
84
|
```
|
|
85
85
|
|
|
86
|
-
## 5
|
|
86
|
+
## 5. Generating tracking links
|
|
87
87
|
|
|
88
88
|
You can also generate the tracking link for a given wallet `address` and `campaign id`
|
|
89
89
|
|