react-native-bdk-sdk 0.1.1 → 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 +51 -12
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -1,24 +1,63 @@
1
- # todo
1
+ ![BDK Banner](https://github.com/Psycarlo/react-native-bdk-sdk/tree/main/assets/bdk-banner.png)
2
2
 
3
- ## Getting Started
3
+ <div align="center">
4
+ <h1>react-native-bdk-sdk</h1>
5
+ <p>Unofficial React Native bindings for BDK</p>
6
+ </div>
4
7
 
5
- ## Maintainers
8
+ <br />
6
9
 
7
- ### Requirements
10
+ A modern, lightweight, descriptor-based wallet library written in Rust! And now, on React Native using uniffi.
8
11
 
9
- - [pnpm](https://pnpm.io/installation)
10
- - [just](https://github.com/casey/just)
12
+ <br />
11
13
 
12
- ### Generate bindings
14
+ <div align="center">
15
+ <a href="https://bitcoindevkit.org/">BDK Website</a> ·
16
+ <a href="https://docs.rs/bdk_wallet/latest/bdk_wallet/">BDK Wallet</a>
17
+ </p>
13
18
 
14
- 1. Install dependencies
19
+ https://bitcoindevkit.org/
20
+ https://docs.rs/bdk_wallet/latest/bdk_wallet/
21
+
22
+
23
+ ## Installation
24
+
25
+ ### Expo
26
+
27
+ 1. Install the package
15
28
 
16
29
  ```bash
17
- pnpm install
30
+ npx expo install react-native-bdk-sdk
18
31
  ```
19
32
 
20
- 2. Generate
33
+ 2. Make sure the plugin is in `app.json`
34
+
35
+ ```json
36
+ {
37
+ "expo": {
38
+ "plugins": ["react-native-bdk-sdk"]
39
+ }
40
+ }
41
+ ```
42
+
43
+ Warning: If you are using pnpm v10+, run pnpm approve-builds and select `react-native-bdk-sdk` to allow the postinstall script to download the prebuilt native binaries.
44
+
45
+ 3. Run prebuild
21
46
 
22
47
  ```bash
23
- just generate
24
- ```
48
+ npx expo prebuild
49
+ ```
50
+
51
+ ### Bare React Native
52
+
53
+ 1. Install the package
54
+
55
+ ```bash
56
+ npm install react-native-bdk-sdk
57
+ ```
58
+
59
+ Note: If you are running on iOS, navigate into the `ios` folder and run `pod install`.
60
+
61
+ ## License
62
+
63
+ Released under the **MIT** license — see the [LICENSE](LICENSE) file for details.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "react-native-bdk-sdk",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "description": "React Native language bindings for the Bitcoin Development Kit",
5
5
  "source": "./src/index.tsx",
6
6
  "main": "./lib/commonjs/index.js",
@@ -79,8 +79,8 @@
79
79
  "access": "public"
80
80
  },
81
81
  "checksums": {
82
- "android": "c1329a399d25aaea84557b1abeaa8571a268ecae9a17bbca93fb594b58208f73",
83
- "ios": "eb53ada52f8b6477ecf4c01bd86124c5ac965f188ba8633da9ec5a47480532c0"
82
+ "android": "5187e0af4f079ac64989d1d0aecffd40a57f7fe3e5f60498eb90cad08c73b289",
83
+ "ios": "dff052cfedc4ec1fec791328fd8fee61f26d93d06929495242d7934b1b9b8786"
84
84
  },
85
85
  "dependencies": {
86
86
  "uniffi-bindgen-react-native": "0.30.0-1"