Skip to content
This repository was archived by the owner on Jan 9, 2026. It is now read-only.

Commit 89a30eb

Browse files
Update README.md
1 parent 41a869e commit 89a30eb

1 file changed

Lines changed: 12 additions & 13 deletions

File tree

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Use the `passage-flex-react-native` SDK to implement Passkey Flex in your React
66

77
For full documentation, including setting up a backend SDK, visit the [Passkey Flex documentation here](https://docs-v2.passage.id/flex).
88

9+
910
## Prerequisites
1011

1112
### A Passkey Flex app
@@ -32,20 +33,20 @@ Install this package using npm:
3233
npm i --save @passageidentity/passage-flex-react-native
3334
```
3435

36+
3537
## App configuration
3638

3739
### Expo
3840

39-
- Add plugin in app.json
41+
- Add plugin in app.json:
4042

4143
```json
4244
"plugins": [
43-
"@passageidentity/passage-flex-react-native",
44-
// ...
45+
"@passageidentity/passage-flex-react-native"
4546
]
4647
```
4748

48-
- Add `ASSOCIATED_DOMAIN` value to `.env` (in your app root)
49+
- Add `ASSOCIATED_DOMAIN` value to your app's `.env` file:
4950

5051
```
5152
ASSOCIATED_DOMAIN=example.com
@@ -57,6 +58,7 @@ npm i --save @passageidentity/passage-flex-react-native
5758

5859
See our [Passkey Complete documentation](https://docs.passage.id/mobile/cross-platform/cross-platform-passkey-configuration) for setting up a React Native app for passkeys and Passage.
5960

61+
6062
## Usage
6163

6264
Import PassageFlex:
@@ -79,9 +81,9 @@ Example:
7981

8082
```tsx
8183
const onPressRegister = async () => {
82-
// 1. Get transaction id string from your backend.
83-
const transactionId = await getRegisterTransactionId("newuser@email.com");
84-
// 2. Prompt user to create a passkey and get a Passage nonce value on success.
84+
// 1. Get transaction id string from your backend.
85+
const transactionId = await getRegisterTransactionId("newuser@email.com");
86+
// 2. Prompt user to create a passkey and get a Passage nonce value on success.
8587
const nonce = await passageFlex.passkey.register(transactionId);
8688
// 3. You can send this nonce to your backend to complete user registration.
8789
};
@@ -95,9 +97,9 @@ Example:
9597

9698
```tsx
9799
const onPressLogIn = async () => {
98-
// 1. Get transaction id string from your backend.
99-
const transactionId = await getLogInTransactionId("existinguser@email.com");
100-
// 2. Prompt user to create a passkey and get a Passage nonce value on success.
100+
// 1. Get transaction id string from your backend.
101+
const transactionId = await getLogInTransactionId("existinguser@email.com");
102+
// 2. Prompt user to create a passkey and get a Passage nonce value on success.
101103
const nonce = await passageFlex.passkey.authenticate(transactionId);
102104
// 3. You can send this nonce to your backend to complete user authentication.
103105
};
@@ -120,6 +122,3 @@ See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the
120122

121123
MIT
122124

123-
---
124-
125-
Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)

0 commit comments

Comments
 (0)