From c13facc241921ab3bbf0c81090a12f4d96150c45 Mon Sep 17 00:00:00 2001 From: Michalis Giakkoupis <128035176+mgiakkou@users.noreply.github.com> Date: Fri, 26 Jul 2024 16:48:51 +0300 Subject: [PATCH] Update readme file according to QA review --- README.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 7e12030d..067307c6 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ the [EUDI Wallet Reference Implementation project description](https://github.co ## Overview -The EUDI Wallet Reference Implementation is built based on the Architecture Reference Framework and aims to showcase a robust and interoperable platform for digital identification, authentication, and electronic signatures based on common standards across the European Union. +The EUDI Wallet Reference Implementation is built based on the [Architecture Reference Framework](https://github.com/eu-digital-identity-wallet/eudi-doc-architecture-and-reference-framework/blob/main/docs/arf.md) and aims to showcase a robust and interoperable platform for digital identification, authentication, and electronic signatures based on common standards across the European Union. The EUDI Wallet Reference Implementation is based on a modular architecture composed of business-agnostic, reusable components that will evolve in incremental steps and can be re-used across multiple projects. The EUDI Wallet Reference Implementation is the application that allows users to: @@ -63,19 +63,6 @@ To support proximity an Android Proximity Verifier is available as an app that c The issuer, verifier service, and verifier app authentication are based on the EUDIW development [IACA](https://github.com/niscy-eudiw/eudi-app-android-wallet-ui/tree/main/resources-logic/src/main/res/raw) -## Disclaimer - -The released software is an initial development release version: -- The initial development release is an early endeavor reflecting the efforts of a short time-boxed period, and by no means can be considered as the final product. -- The initial development release may be changed substantially over time, might introduce new features but also may change or remove existing ones, potentially breaking compatibility with your existing code. -- The initial development release is limited in functional scope. -- The initial development release may contain errors or design flaws and other problems that could cause system or other failures and data loss. -- The initial development release has reduced security, privacy, availability, and reliability standards relative to future releases. This could make the software slower, less reliable, or more vulnerable to attacks than mature software. -- The initial development release is not yet comprehensively documented. -- Users of the software must perform sufficient engineering and additional testing to properly evaluate their application and determine whether any of the open-sourced components are suitable for use in that application. -- We strongly recommend not putting this version of the software into production use. -- Only the latest version of the software will be supported - ## Important things to know The main purpose of the reference implementation is to showcase the ecosystem and act as a technical example of how to integrate and use all of the available components. @@ -108,22 +95,22 @@ Proximity ## How to use the application -Minimum device requirements +### Minimum device requirements - API level 26. -Prerequisites +### Prerequisites You can download the application [here](https://install.appcenter.ms/orgs/eu-digital-identity-wallet/apps/eudi-reference-android/distribution_groups/eudi%20wallet%20(demo)%20public) You will also need to download the Android Verifier app [here](https://install.appcenter.ms/orgs/eu-digital-identity-wallet/apps/mdoc-verifier-testing/distribution_groups/eudi%20verifier%20(testing)%20public) -App launch +### App launch 1. Launch the application 2. You will be presented with a welcome screen where you will be asked to create a PIN for future logins. -Issuance flow (Scoped) +### Issuance flow (Scoped) 1. Open the "Add document" screen or if it's the first time you open the app, you will be redirected there after you enter or set up your PIN. 2. Pick "National ID". @@ -133,7 +120,7 @@ Issuance flow (Scoped) 6. Your "National ID" is displayed. Tap "Continue". 7. You are now on the "Dashboard" screen. -Issuance flow (Credential Offer) +### Issuance flow (Credential Offer) 1. Open the "Add document" screen or if it's the first time you open the app, you will be redirected there after you enter or set up your PIN. 2. Tap "SCAN QR". @@ -146,7 +133,7 @@ While on the "Dashboard" screen you can tap "Add doc" and issue a new document, If you want to re-issue a document you must delete it first by tapping on the document in the "Dashboard" screen and tapping the delete icon in the "Document details" view. -Presentation (Online authentication/Same device) flow. +### Presentation (Online authentication/Same device) flow. 1. Go to the browser application on your device and enter "https://verifier.eudiw.dev" 2. Tap the first option (selectable) and pick the fields you want to share (e.g. "Family Name" and "Given Name") @@ -158,7 +145,7 @@ Presentation (Online authentication/Same device) flow. 8. A browser will open showing that the Verifier has accepted your request. 9. Return to the app. You are back to the "Dashboard" screen and the flow is complete. -Proximity flow +### Proximity flow 1. The user logs in successfully to the EUDI Wallet app and views the dashboard. 2. The user clicks the 'SHOW QR/TAP' button to display the QR code. @@ -180,6 +167,19 @@ Proximity flow You can find instructions on how to configure the application [here](wiki/configuration.md) +## Disclaimer + +The released software is an initial development release version: +- The initial development release is an early endeavor reflecting the efforts of a short time-boxed period, and by no means can be considered as the final product. +- The initial development release may be changed substantially over time, might introduce new features but also may change or remove existing ones, potentially breaking compatibility with your existing code. +- The initial development release is limited in functional scope. +- The initial development release may contain errors or design flaws and other problems that could cause system or other failures and data loss. +- The initial development release has reduced security, privacy, availability, and reliability standards relative to future releases. This could make the software slower, less reliable, or more vulnerable to attacks than mature software. +- The initial development release is not yet comprehensively documented. +- Users of the software must perform sufficient engineering and additional testing to properly evaluate their application and determine whether any of the open-sourced components are suitable for use in that application. +- We strongly recommend not putting this version of the software into production use. +- Only the latest version of the software will be supported + ## Package structure *assembly-logic*: App dependencies.