chore: updating Documentation and Developer Guide (#790)

bcgov · Jan 9, 2023 · d35f577 · d35f577
1 parent 7535a7c
commit d35f577
Show file tree

Hide file tree

Showing 7 changed files with 371 additions and 101 deletions.
diff --git a/DEVELOPER.md b/DEVELOPER.md
diff --git a/README.md b/README.md
@@ -1,6 +1,26 @@
 
 ![Lifecycle:Maturing](https://img.shields.io/badge/Lifecycle-Maturing-007EC6)
+[![Native Build & Test](https://github.com/bcgov/bc-wallet-mobile/actions/workflows/main.yaml/badge.svg?branch=main)](https://github.com/bcgov/bc-wallet-mobile/actions/workflows/main.yaml)
+
+# Table of Contents
+<!-- TOC -->
+* [Prerequisite](#prerequisite)
+* [Overall Architecture](#overall-architecture)
+<!-- TOC -->
+
+# Prerequisite
+Before running the mobile app it is expected to the following services up and running. (Either locally or hosted
+somewhere on the internet.)
+
+1. [Von-Network Blockchain Ledger](https://github.com/bcgov/von-network)
+2. [Mediator](https://github.com/hyperledger/aries-mediator-service)
+3. [Credential Issuer](https://github.com/bcgov/issuer-kit)
+4. An account in [NgRok](https://dashboard.ngrok.com/get-started/setup)
+5. Follow the steps in the [Developer Guide](DEVELOPER.md)
+
+# Overall Architecture
+How BC Wallet Mobile App fits in a larger picture?
+
+![](<./docs/BCWallet_Architecture.png>)
 
-# TL;DR
 
-Under construction...
diff --git a/docs/BCWallet_Architecture.png b/docs/BCWallet_Architecture.png
diff --git a/docs/Emulator-debug-menu.png b/docs/Emulator-debug-menu.png
diff --git a/docs/intellij-debug-btn.png b/docs/intellij-debug-btn.png
diff --git a/docs/intellij-debugging.png b/docs/intellij-debugging.png
diff --git a/docs/intellij-run-debug-config.png b/docs/intellij-run-debug-config.png