From d72340fcd5b301aa75f7347a6e3aad7c93dc0efb Mon Sep 17 00:00:00 2001 From: Daniel Eder Date: Tue, 27 Apr 2021 14:16:12 +0200 Subject: [PATCH] Update readme --- README.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index a2e7c6e..d20681d 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@

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

-- [ ] TODO +## About + +This repository contains the source code of the Digital Green Certificates App Core for Android. + +The app core provides shared functionality for the [verifier](https://github.com/eu-digital-green-certificates/dgca-verifier-app-android) and [wallet](https://github.com/eu-digital-green-certificates/dgca-wallet-app-android) apps. ## Development ### Prerequisites -- [ ] TODO +- [ ] TODO: Describe prerequisites ### Build @@ -31,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