Skip to content

Commit

Permalink
feat: update rn-signer readme to contain additional setup information
Browse files Browse the repository at this point in the history
  • Loading branch information
iykazrji committed Nov 22, 2024
1 parent 2b4df22 commit 3f0385a
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion account-kit/rn-signer/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,28 @@
# @account-kit/react-native-signer
# @account-kit/react-native-signer (Alpha)

React Native compatible Alchemy signer impl

## ⚠️ Alpha ⚠️

This is an alpha release of the library. Only the **Android** platform is supported at this time.

## Installation

```sh
npm install @account-kit/react-native-signer
```

## Usage

This package requires the `react-native-mmkv` package installed in your project. Check out their [docs](https://github.com/mrousavy/react-native-mmkv) for installation instructions.

#### Deep Linking.

Your app will need to be configured to handle deep linking. Check out the React Native [docs](https://reactnative.dev/docs/linking#enabling-deep-links) for more information.
You will also need a way to trigger the deep link via a http or https url. This can be done in a viarety of ways ranging from universal links to setting up a custom redirect server.

See the [example app](./example) for usage information.

## Contributing

1. Clone the repo
Expand Down

0 comments on commit 3f0385a

Please sign in to comment.