diff --git a/README.md b/README.md index d904a3b9..302415c7 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,19 @@ # AffinidiID -* [Description](#description) -* [What is Affinidi Wallet](#what-is-affinidi-wallet) -* [Used APIs](#used-apis) -* [Implemented use cases](#implemented-use-cases) +* [About the app](#about-the-app) + * [Description](#description) + * [Gallery](#gallery) * [Technical details](#technical-details) - * [Overview](#overview) + * [Android](#android) + * [Used APIs](#used-apis) * [Schemas](#schemas) -## Description -**AffinidiID** is an android app built for learning purpose. Created to dive into the technical aspects of **Self-Sovereign Identity** and **Verifiable Credentials** [concepts](hhttps://academy.affinidi.com/an-in-depth-exploration-of-self-sovereign-identity-and-verifiable-credentials-1a3eb2296004) using Affinidi open APIs. -The second objective was to practice with Clean Architecture. - -

- - - - -

- -## What is Affinidi Wallet -The Affinidi Wallet is a web-based responsive SSI [wallet application](https://wallet.affinidi.com/) for holders to request, store, share and manage their Veriiable Credentials. - -## Used APIs -In this application the [Affinidi APIs](https://build.affinidi.com/docs/api) are used to create Affinidi user account and interact with the wallet. - -Also [DiceBear Avatars API](https://avatars.dicebear.com/) is used to generate unique avatars depending on the user's DID. +## About the app +### Description +**AffinidiID** is a VC wallet app built for learning purpose. Created to dive into the technical aspects of **Self-Sovereign Identity** and **Verifiable Credentials** [concepts](hhttps://academy.affinidi.com/an-in-depth-exploration-of-self-sovereign-identity-and-verifiable-credentials-1a3eb2296004) using Affinidi open APIs. The second objective was to practice with Clean Architecture. -## Implemented use cases -The last version covers the following use cases: +Actually, it works as native android frontend close to Affinidi [wallet application](https://wallet.affinidi.com/) but with the possibility to issue a test credential. The last version covers the following use cases: **User profile** - Sign up @@ -43,14 +27,38 @@ The last version covers the following use cases: - Issue credentials - Store credentials in Affinidi Wallet - View credentials (list + details) +- Share credentials via QR code - Verify credentials - Delete credentials from Affinidi Wallet "Edit username" feature was deleted due to API issue. The original name becomes lost immediately after OTP is sent (without confirmation). +### Gallery + +#### Manage Affinidi profile +

+ + + +

+ +#### Issue and store credentials +

+ + + +

+ +#### Share and verify credentials +

+ + + +

+ ## Technical details -### Overview +### Android - Attempts to use clean architecture approach. Presentation / data / domain layers each in a separate module. - Single activity approach and [Navigation component](https://developer.android.com/guide/navigation) (with SafeArgs) to navigate across fragments. @@ -62,9 +70,14 @@ The last version covers the following use cases: - [Room](https://developer.android.com/jetpack/androidx/releases/room) for credentials caching. - [Timber](https://github.com/JakeWharton/timber) for logging. - [CircleImageView](https://github.com/hdodenhof/CircleImageView) for rounded images, [Coil](https://github.com/coil-kt/coil) to load SVG images into ImageView. +- Unit tests (junit4) -### Schemas +### Used APIs +In this application the [Affinidi APIs](https://build.affinidi.com/docs/api) are used to create Affinidi user account and interact with the wallet. + +Also [DiceBear Avatars API](https://avatars.dicebear.com/) is used to generate unique avatars depending on the user's DID. +### Schemas

- -

\ No newline at end of file + +

diff --git a/doc/screenshot_credential_details.webp b/doc/screenshot_credential_details.webp deleted file mode 100644 index f519a504..00000000 Binary files a/doc/screenshot_credential_details.webp and /dev/null differ diff --git a/doc/screenshot_credentials_list.webp b/doc/screenshot_credentials_list.webp deleted file mode 100644 index eab28f80..00000000 Binary files a/doc/screenshot_credentials_list.webp and /dev/null differ diff --git a/doc/screenshot_profile.webp b/doc/screenshot_profile.webp deleted file mode 100644 index 481943e2..00000000 Binary files a/doc/screenshot_profile.webp and /dev/null differ diff --git a/doc/screenshot_sign_in.webp b/doc/screenshot_sign_in.webp deleted file mode 100644 index 13660150..00000000 Binary files a/doc/screenshot_sign_in.webp and /dev/null differ diff --git a/doc/vc_models_schema.webp b/doc/vc_models_schema.webp deleted file mode 100644 index 80873857..00000000 Binary files a/doc/vc_models_schema.webp and /dev/null differ