@fonoster/sdk 0.6.3 → 0.6.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.
Files changed (2) hide show
  1. package/README.md +15 -7
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -15,13 +15,19 @@ This package provides a set of utilities for working with Fonoster services. It
15
15
  ## Installation
16
16
 
17
17
  ```sh-session
18
- $ npm install --save @fonoster/sdk
18
+ $ npm install --save @fonoster/sdk@next
19
+ ```
20
+
21
+ Or using yarn:
22
+
23
+ ```sh-session
24
+ $ yarn add @fonoster/sdk@next
19
25
  ```
20
26
 
21
27
  Or in the browser:
22
28
 
23
29
  ```html
24
- <script src="https://unpkg.com/@fonoster/sdk"></script>
30
+ <script src="https://unpkg.com/@fonoster/sdk@next"></script>
25
31
  ```
26
32
 
27
33
  ### Importing the library
@@ -41,7 +47,7 @@ import * as SDK from "@fonoster/sdk";
41
47
  Directly in the browser:
42
48
 
43
49
  ```html
44
- <script src="https://unpkg.com/@fonoster/sdk"></script>
50
+ <script src="https://unpkg.com/@fonoster/sdk@next"></script>
45
51
  <script>
46
52
  // You can now use the SDK
47
53
  </script>
@@ -58,20 +64,22 @@ In Node.js:
58
64
  ```typescript
59
65
  const SDK = require("@fonoster/sdk");
60
66
  const accessKeyId = "WO00000000000000000000000000000000";
61
- const client = new SDK.Client({ accessKeyId });
67
+ const endpoint = "https://api.fonoster.io";
68
+ const client = new SDK.Client({ accessKeyId, endpoint });
62
69
  ```
63
70
 
64
- By default, the Client object will point to Fonoster's cloud services. If you are running your own instance of Fonoster, you can specify the `endpoint` parameter to point to it.
71
+ When connecting to Fonoster's cloud services, you can omit the `endpoint` parameter.
65
72
 
66
73
  In the browser:
67
74
 
68
75
  ```typescript
69
76
  const SDK = require("@fonoster/sdk");
70
77
  const accessKeyId = "WO00000000000000000000000000000000";
71
- const client = new SDK.WebClient({ accessKeyId });
78
+ const url = "https://api.fonoster.io/v1beta2";
79
+ const client = new SDK.WebClient({ accessKeyId, url });
72
80
  ```
73
81
 
74
- By default, the WebClient object points to Fonoster's cloud services. If you are running your own instance of Fonoster, you can specify the `url` parameter to point to it.
82
+ When connecting to Fonoster's cloud services, you can omit the `url` parameter.
75
83
 
76
84
  ### Login in and making requests
77
85
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fonoster/sdk",
3
- "version": "0.6.3",
3
+ "version": "0.6.4",
4
4
  "description": "Web and Node.js SDK for Fonoster",
5
5
  "author": "Pedro Sanders <psanders@fonoster.com>",
6
6
  "homepage": "https://github.com/fonoster/fonoster#readme",
@@ -60,5 +60,5 @@
60
60
  "rollup": "^4.18.0",
61
61
  "serve": "^14.2.3"
62
62
  },
63
- "gitHead": "24f66848ab38c96f6e19b59cfb4dd1486b82ed64"
63
+ "gitHead": "0c94ef1aa747a167ab4dc8bb788d2646f715a344"
64
64
  }