Skip to content

Commit

Permalink
Merge branch 'PSG-4895-use-repo-templates' of https://github.com/pass…
Browse files Browse the repository at this point in the history
…ageidentity/passage-android into PSG-4895-use-repo-templates
  • Loading branch information
jenn-macfarlane committed Oct 22, 2024
2 parents b039025 + 1197325 commit 89d405c
Showing 1 changed file with 6 additions and 83 deletions.
89 changes: 6 additions & 83 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,90 +15,13 @@ Use [Passkey Ready](https://docs.passage.id/passkey-ready) to determine if your

### In passage-android

Use passage-android to implement [passage-android/passage](https://github.com/passageidentity/passage-android/tree/main/passage) in your Android application to authenticate requests and manage users, [passage-android/passageflex](https://github.com/passageidentity/passage-android/tree/main/passageflex) in your existing auth to use passkeys for registration, authentication, or added security on sensitive user actions, and [passage-android/authentikit](https://github.com/passageidentity/passage-android/tree/main/authentikit) to gather data on your users' passkey readiness.
Use passage-android to implement Passkey Complete, Passkey Flex, or Passkey Ready in your Android applications. Use the table below to find installation and implementation guides for each product.

| Product | Compatible |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| ![Passkey Flex](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-flex-icon.png) Passkey **Flex** ||
| ![Passkey Complete](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-complete-icon.png) Passkey **Complete** ||
| ![Passkey Ready](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-ready-icon.png) Passkey **Ready** ||

## Getting Started

### Passkey Complete

#### Check Prerequisites

<p>
You'll need a free Passage account and a Passkey Complete app set up in <a href="https://console.passage.id/">Passage Console</a> to get started. <br />
<sub><a href="https://docs.passage.id/home#passage-console">Learn more about Passage Console →</a></sub>
</p>

#### Install

```gradle
implementation 'id.passage.android:passage:2.0.2'
```

#### Initialize

```kotlin
val passage = Passage(activity, "YOUR_PASSAGE_APP_ID")
```

#### Go Passwordless

Find all core functions, user management details, and more implementation guidance on our [Passkey Complete Android Documentation](https://docs.passage.id/complete/android/add-passage) page.

### Passkey Flex

#### Check Prerequisites

<p>
You'll need a free Passage account and a Passkey Flex app set up in <a href="https://console.passage.id/">Passage Console</a> to get started. <br />
<sub><a href="https://docs.passage.id/home#passage-console">Learn more about Passage Console →</a></sub>
</p>

#### Install

```gradle
implementation 'id.passage.android:passageflex:0.2.0'
```

#### Initialize

```kotlin
val passageFlex = PassageFlex(activity, "YOUR_PASSAGE_APP_ID")
```

#### Go Passwordless

Find all core functions, user management details, and more implementation guidance on our [Passkey Flex Android Documentation](https://docs.passage.id/flex/android/config) page.

### Authentikit

#### Check Prerequisites

<p>
You'll need a free Passage account and Organization set up via <a href="https://console.passage.id/">Passage Console</a> to get started. <br />
<sub><a href="https://docs.passage.id/home#passage-console">Learn more about Passage Console →</a></sub>
</p>

#### Install

```gradle
implementation 'id.passage.android:authentikit:0.1.0'
```

#### Initialize

```kotlin
val authentikit = Authentikit(this, "YOUR_CLIENT_SIDE_KEY")
```

#### Go Passwordless

Find all core functions and more implementation guidance on our [Passkey Ready Documentation](https://docs.passage.id/passkey-ready) page.
| Product | Compatible |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| ![Passkey Flex](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-flex-icon.png) Passkey **Flex** |[passage-android/passage](https://github.com/passageidentity/passage-android/tree/main/passage) |
| ![Passkey Complete](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-complete-icon.png) Passkey **Complete** |[passage-android/passageflex](https://github.com/passageidentity/passage-android/tree/main/passageflex) |
| ![Passkey Ready](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-ready-icon.png) Passkey **Ready** |[passage-android/authentikit](https://github.com/passageidentity/passage-android/tree/main/authentikit) |

## Support & Feedback

Expand Down

0 comments on commit 89d405c

Please sign in to comment.