From b604b452a051141f31ede439653dbf6470c1b83c Mon Sep 17 00:00:00 2001 From: Daniel Eder Date: Tue, 27 Apr 2021 13:57:33 +0200 Subject: [PATCH] Update readme --- README.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index efa10ca..8cb5df5 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@

+ AboutDevelopmentDocumentationSupport • @@ -17,11 +18,17 @@ Licensing

+## About + +This repository contains the source code of the Digital Green Certificates Wallet App for iOS. + +The wallet app provides a user interface to store and manage personal DGCs directly on the phone. DGCs will be imported by scanning a base45-encoded QR code and decoding CBOR to JSON. Afterwards, it is symmetrically encrypted in the app’s sandbox and the symmetric key is stored in the system’s keychain. Multiple DGCs can be stored in the app. Access to the app is controlled via biometric data (e. g., Touch ID or Face ID). The wallet app can display any imported DGC as QR code for scanning and verifying with the verifier app. + ## Development ### Prerequisites -- [ ] TODO +- [ ] TODO: Describe prerequisites ### Build @@ -29,21 +36,13 @@ Whether you cloned or downloaded the 'zipped' sources you will either find the s In either case open a terminal pointing to the directory you put the sources in. The local build process is described afterwards depending on the way you choose. -#### XYZ (Maven, ...) based build - -- [ ] TODO - -#### Build Docker Image - -- [ ] TODO - -#### API documentation +#### XYZ (Maven, Docker ...) based build -- [ ] TODO +- [ ] TODO: Add instructions for different build types ## Documentation -- [ ] TODO +- [ ] TODO: Link to documentation ## Support and feedback