Skip to content

Commit

Permalink
README: update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
kaloudis committed Nov 17, 2022
1 parent 716b6ce commit f9f0e08
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## Persistant 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
Expand Down

0 comments on commit f9f0e08

Please sign in to comment.