@onekeyfe/hd-ble-sdk 0.1.50 → 0.1.52

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 +30 -5
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -1,11 +1,36 @@
1
- # `hd-ble-sdk`
1
+ # `@onekeyfe/hd-ble-sdk`
2
2
 
3
- > TODO: description
3
+ `@onekeyfe/hd-ble-sdk` is a library provided for mobild client. Its dependency on `@onekeyfe/hd-transport-react-native`. We recommend using this libarary in ReactNative applications.
4
4
 
5
- ## Usage
5
+ ## Installation
6
6
 
7
+ Install library as npm module:
8
+
9
+ ```javascript
10
+ npm install @onekeyfe/hd-ble-sdk
7
11
  ```
8
- const hdBleSdk = require('hd-ble-sdk');
9
12
 
10
- // TODO: DEMONSTRATE API
13
+ or
14
+
15
+ ```javascript
16
+ yarn add @onekeyfe/hd-ble-sdk
11
17
  ```
18
+
19
+ ## Initialization
20
+
21
+ ```javascript
22
+ import HardwareSDK from '@onekeyfe/hd-ble-sdk';
23
+
24
+ function init() {
25
+ HardwareSDK.init({
26
+ debug: false,
27
+ });
28
+ }
29
+ ```
30
+
31
+ ## Docs
32
+
33
+ Documentation is available [hardware-js-sdk](https://developer.onekey.so/connect-to-hardware/hardware-sdk/start)
34
+
35
+ ## Examples
36
+ // TODO: add example url
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@onekeyfe/hd-ble-sdk",
3
- "version": "0.1.50",
3
+ "version": "0.1.52",
4
4
  "author": "OneKey",
5
5
  "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
6
6
  "license": "ISC",
@@ -20,9 +20,9 @@
20
20
  "lint:fix": "eslint . --fix"
21
21
  },
22
22
  "dependencies": {
23
- "@onekeyfe/hd-core": "^0.1.50",
24
- "@onekeyfe/hd-shared": "^0.1.50",
25
- "@onekeyfe/hd-transport-react-native": "^0.1.50"
23
+ "@onekeyfe/hd-core": "^0.1.52",
24
+ "@onekeyfe/hd-shared": "^0.1.52",
25
+ "@onekeyfe/hd-transport-react-native": "^0.1.52"
26
26
  },
27
- "gitHead": "e3e2a8aa77a1bf72d1b26dc9841463a660a2f902"
27
+ "gitHead": "7a53d20af1efe25b5f94c1204bb1679cfeb16666"
28
28
  }