Skip to content

Commit

Permalink
Merge pull request eu-digital-green-certificates#8 from eu-digital-gr…
Browse files Browse the repository at this point in the history
…een-certificates/docs/readme-description

Add description to readme
  • Loading branch information
daniel-eder authored Apr 27, 2021
2 parents ad69369 + ea90d21 commit 7af25e3
Showing 1 changed file with 9 additions and 13 deletions.
22 changes: 9 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,35 +17,31 @@
<a href="#licensing">Licensing</a>
</p>

- [ ] TODO
## About

This repository contains the source code of the Digital Green Certificates Verifier App for Android.

The DGC Verifier Apps are responsible for scanning and verifying DGCs using public keys from national backend servers. Offline verification is supported, if the latest public keys are present in the app's key store. Consequently, once up-to-date keys have been downloaded, the verification works without active internet connection.

## Development

### Prerequisites

- [ ] TODO
- [ ] TODO: Describe prerequisites

### Build

Whether you cloned or downloaded the 'zipped' sources you will either find the sources in the chosen checkout-directory or get a zip file with the source code, which you can expand to a folder of your choice.

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

Expand Down

0 comments on commit 7af25e3

Please sign in to comment.