Skip to content

Commit da57f28

Browse files
authored
chore: Improve the README with component information and compatibility guidance (#30)
1 parent a7ab396 commit da57f28

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,25 @@
99
[![Open Bugs](https://img.shields.io/github/issues/aws-amplify/amplify-ui-android/bug?color=d73a4a&label=bugs)](https://github.com/aws-amplify/amplify-ui-android/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
1010
[![Feature Requests](https://img.shields.io/github/issues/aws-amplify/amplify-ui-android/feature-request?color=ff9001&label=feature%20requests)](https://github.com/aws-amplify/amplify-ui-android/issues?q=is%3Aissue+label%3Afeature-request+is%3Aopen)
1111

12-
Amplify UI for Android is an open-source UI library with components that are endlessly customizable, accessible, and can integrate into _any_ Android application. Amplify UI consists of:
12+
Amplify UI for Android is an open-source UI library with cloud-connected components that are endlessly customizable, accessible, and can integrate into _any_ Android Compose application.
1313

14-
1. Connected components that simplify complex cloud-connected workflows.
15-
3. Theming capabilities that allow you to customize the appearance of Amplify UI to match your brand.
14+
## Connected Components
15+
16+
| Component | Summary | Latest Version | Docs | Sample |
17+
| --- | --- | --- | --- | --- |
18+
| [Authenticator](authenticator) | Amplify Authenticator provides a complete drop-in implementation of an authentication flow for your application using [Amplify Authentication](https://docs.amplify.aws/lib/auth/getting-started/q/platform/android/). | [dev-preview.0](https://github.com/aws-amplify/amplify-ui-android/releases/tag/release_authenticator_v1.0.0-dev-preview.0) | [Docs](https://ui.docs.amplify.aws/android/connected-components/authenticator) | [Sample](samples/authenticator/) |
19+
| [Face Liveness](liveness) | Amplify FaceLivenessDetector provides a UI component for [Amazon Rekognition Face Liveness](https://aws.amazon.com/rekognition/face-liveness/) feature that helps developers verify that only real users, not bad actors using spoofs, can access your services. | [1.0.0](https://github.com/aws-amplify/amplify-ui-android/releases/tag/release_liveness_v1.0.0) | [Docs](https://ui.docs.amplify.aws/android/connected-components/liveness) | [Sample](samples/liveness/) |
20+
21+
## Compatibility Reference
22+
23+
| Component | Version | Amplify | Material3 |
24+
| --- | --- | --- | --- |
25+
| Authenticator | dev-preview.0 | 2.7.1+ | 1.0.1 |
26+
| Liveness | 1.0.0 | 2.7.0+ | 1.0.1+ |
27+
28+
## Getting Started
29+
30+
- https://ui.docs.amplify.aws/android/getting-started/installation
1631

1732
## Contributing
1833

0 commit comments

Comments
 (0)