Merge pull request #102 from alexandr7035/doc

Update doc (v3.0)

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.
-
-<p align="left">
-<img src="doc/screenshot_sign_in.webp" width="23%"/>
-<img src="doc/screenshot_profile.webp" width="23%"/>
-<img src="doc/screenshot_credentials_list.webp" width="23%"/>
-<img src="doc/screenshot_credential_details.webp" width="23%"/>
-</p>
-
-## 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
+<p align="left">
+<img src="https://user-images.githubusercontent.com/22574399/154146941-588fd474-39cf-4e0b-a338-dbf9c74f34d7.png" width="25%"/>
+<img src="https://user-images.githubusercontent.com/22574399/154146971-99e5fbb8-3909-48ab-8183-222def88154a.png" width="25%"/>
+<img src="https://user-images.githubusercontent.com/22574399/154146986-f84bcac6-0600-49d0-92c2-d28e9b15ff03.png" width="25%"/>
+</p>
+
+#### Issue and store credentials
+<p align="left">
+<img src="https://user-images.githubusercontent.com/22574399/154147710-1808ca85-496a-4db8-8185-0d820c416432.png" width="25%"/>
+<img src="https://user-images.githubusercontent.com/22574399/154147760-b73f8699-9766-4ace-8099-773cb837cc6a.png" width="25%"/>
+<img src="https://user-images.githubusercontent.com/22574399/154147804-3ce1f6ee-bcfd-4534-8667-4b4c879bc335.png" width="25%"/>
+</p>
+
+#### Share and verify credentials
+<p align="left">
+<img src="https://user-images.githubusercontent.com/22574399/154148135-3d92c7b0-1934-4ded-b45c-9180a659ab0a.png" width="25%"/>
+<img src="https://user-images.githubusercontent.com/22574399/154148769-62395099-391c-41ff-b81b-524556eaac63.png" width="25%"/>
+<img src="https://user-images.githubusercontent.com/22574399/154148903-21b9d058-98d3-4e5c-bd45-97f152a48636.png" width="25%"/>
+</p>
+
 ## 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
 <p align="left">
-<img src="doc/vc_models_schema.webp" width="100%"/>
-</p>
+<img src="https://user-images.githubusercontent.com/22574399/154149516-e73f75e8-9ab7-46b9-8427-4d840f95215f.png" width="100%"/>
+</p>