Skip to content

Commit 0db5100

Browse files
authored
Merge pull request #9 from lightninglabs/update-install-instructions
README: update installation instructions
2 parents ea3dd6c + a526918 commit 0db5100

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,37 @@
44

55
## Install
66

7+
First, install the npm module
78
`npm i @lightninglabs/lnc-rn`
89

10+
Navigate to the lnc-rn npm module folder
11+
`cd node_modules/@lightninglabs/lnc-rn`
12+
13+
Fetch the required LNC libraries
14+
`npm run fetch-libraries`
15+
16+
### Android
17+
18+
In your app's `android/app/build.gradle` file, add the following line to your `dependency` block:
19+
20+
```implementation files("../../node_modules/@lightninglabs/lnc-rn/android/libs/lnc-mobile.aar")```
21+
22+
### iOS
23+
24+
First, in Xcode, drag the `Lncmobile.xcframework` folder into your Xcode project - ideally grouped in the project's Framework folder. Make sure you add it to your project's primary target.
25+
26+
The `Lncmobile.xcframework` folder can be found in the `node_modules/@lightninglabs/lnc-rn/ios` directory.
27+
28+
Then, in your project's `ios` folder, run `pod install`.
29+
30+
### Building library files manually
31+
32+
The library files can be built manually from the [Lightning Node Connect](https://github.com/lightninglabs/lightning-node-connect) repo using the `make android` and `make ios` commands.
33+
34+
## Persistent storage
35+
36+
Unlike [lnc-web](https://github.com/lightninglabs/lnc-web), lnc-rn does not store users' credentials by defaults. We recommend taking a look at one of the [credentialStores](https://github.com/lightninglabs/lnc-rn/blob/main/demos/connect-demo/credentialStore.ts) from our demo apps to see how you can store users' credentials securely using [react-native-encrypted-storage](https://github.com/emeraldsanto/react-native-encrypted-storage).
37+
938
## API Design
1039

1140
#### Set-up and connection

0 commit comments

Comments
 (0)