File tree Expand file tree Collapse file tree 1 file changed +24
-11
lines changed
Expand file tree Collapse file tree 1 file changed +24
-11
lines changed Original file line number Diff line number Diff line change @@ -12,21 +12,21 @@ This library hopes to simplify the process of adding Lightning via LDK to any Re
1212yarn add @synonymdev/react-native-ldk
1313# or
1414npm i -S @synonymdev/react-native-ldk
15- ````
15+ ```
1616
1717### iOS installation
1818``` bash
1919cd ios && pod install && cd ../
20- ` ` ` `
20+ ```
2121
2222### Android installation
23231 . Add the following line to ` dependencies ` in ` /android/app/build.gradle `
24- ` ` `
25- dependencies {
26- ...
27- implementation files(" ../../node_modules/@synonymdev/react-native-ldk/android/libs/LDK-release.aar" )
28- }
29- ```
24+ ``` groovy
25+ dependencies {
26+ // ...
27+ implementation files("../../node_modules/@synonymdev/react-native-ldk/android/libs/LDK-release.aar") // <- this
28+ }
29+ ```
30302. Ensure `minSdkVersion` is set to at least `24` in `/android/build.gradle`
3131
3232## Development
@@ -40,19 +40,32 @@ dependencies {
4040 5. In the popup that appears select `JavaDocs` and tap `OK` then `OK` again
4141
4242## Running example app
43+ See also [`./example/README.md`](./example/README.md)
4344```bash
44-
45- # Build dist files
45+ # Build dist files
4646git clone https://github.com/synonymdev/react-native-ldk.git
4747cd react-native-ldk/lib/ && yarn install && yarn build && cd ../
4848
4949cd example/ && yarn install && yarn rn-setup
5050
5151yarn ios
52- # or
52+ # or
5353yarn android
5454```
5555
56+ ### Update config to match your local setup
57+ In ` constants.ts ` update ` peers.lnd ` if you're using Polar locally.
58+ ### Example for Android
59+ ``` ts
60+ // export const peers = {
61+ // lnd: {
62+ pubKey :
63+ ' _033f4d3032ce7f54224f4bd9747b50b7cd72074a859758e40e1ca46ffa79a34324_' ,
64+ address : ' 10.0.2.2' ,
65+ port : 9737 ,
66+ // },
67+ ```
68+
5669## Notes
5770 - It is important to not mix and match account names and seeds when starting LDK. Doing so can result in a corrupt save.
5871
You can’t perform that action at this time.
0 commit comments