From 8bd58753ddf956d2671094342ce852895ea188e6 Mon Sep 17 00:00:00 2001 From: Evan Kaloudis Date: Thu, 17 Nov 2022 13:00:49 -0500 Subject: [PATCH] README: update installation instructions --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index f60b240..f2ae1ef 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,22 @@ `npm i @lightninglabs/lnc-rn` +### Android + +In your app's `android/app/build.gradle` file, add the following line to your `dependency` block: + +```implementation files("../../node_modules/@lightninglabs/lnc-rn/android/libs/lnc-mobile.aar")``` + +### iOS + +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. + +The `Lncmobile.xcframework` folder can be found in the `node_modules/@lightninglabs/lnc-rn/ios` directory. + +## Persistent storage + +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). + ## API Design #### Set-up and connection