@bizkit.io/webclient 0.1.0 → 0.1.2

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 +16 -10
  2. package/package.json +6 -1
package/README.md CHANGED
@@ -1,23 +1,29 @@
1
- # vite-plus-starter
1
+ # bizkit.io web client
2
2
 
3
- A starter for creating a Vite Plus project.
3
+ Under development.
4
4
 
5
5
  ## Development
6
6
 
7
- - Install dependencies:
7
+ - Install:
8
8
 
9
9
  ```bash
10
- vp install
10
+ npm install @bizkit.io/webclient
11
11
  ```
12
12
 
13
- - Run the unit tests:
13
+ - Import:
14
14
 
15
- ```bash
16
- vp test
15
+ ```typescript
16
+ import { type BizkitToken, bizkit_init, get_bizkit_token } from "@bizkit.io/webclient";
17
17
  ```
18
18
 
19
- - Build the library:
19
+ - Initialize the web client:
20
20
 
21
- ```bash
22
- vp pack
21
+ ```typescript
22
+ await bizkit_init(false); // false for development, true for production
23
+ ```
24
+
25
+ - Get a token:
26
+
27
+ ```typescript
28
+ const token: BizkitToken = await get_bizkit_token();
23
29
  ```
package/package.json CHANGED
@@ -1,7 +1,12 @@
1
1
  {
2
2
  "name": "@bizkit.io/webclient",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "Web client to get bizkit.io tokens",
5
+ "keywords": [
6
+ "bizkit.io",
7
+ "paywall",
8
+ "token"
9
+ ],
5
10
  "homepage": "https://github.com/bizkit.io/webclient#readme",
6
11
  "bugs": {
7
12
  "url": "https://github.com/bizkit.io/webclient/issues"