Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-eder committed Apr 27, 2021
1 parent 5552bdb commit b475bc4
Showing 1 changed file with 10 additions and 13 deletions.
23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,35 +17,32 @@
<a href="#licensing">Licensing</a>
</p>

- [ ] TODO
## About

This repository contains the source code of the Digital Green Certificates Verifier Service.

The DGC Verifier Service is part of the national backends and caches the public keys that are distributed through the [DGCG](https://github.com/eu-digital-green-certificates/dgc-gateway). It is accessed by the DGC Verifier Apps ([Android](https://github.com/eu-digital-green-certificates/dgca-verifier-app-android), [iOS](https://github.com/eu-digital-green-certificates/dgca-verifier-app-ios)) to update the key store periodically.

## 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
#### XYZ (Maven, Docker ...) based build

- [ ] TODO

#### API documentation

- [ ] TODO
- [ ] TODO: Add instructions for different build types

## Documentation

- [ ] TODO
- [ ] TODO: Link to documentation


## Support and feedback

Expand Down

0 comments on commit b475bc4

Please sign in to comment.