Skip to content

Commit

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

Add description to readme
  • Loading branch information
daniel-eder authored Apr 27, 2021
2 parents ee02362 + 453f24f commit 7c2f4cd
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 @@ -9,6 +9,7 @@
</p>

<p align="center">
<a href="#about">About</a> •
<a href="#development">Development</a> •
<a href="#documentation">Documentation</a> •
<a href="#support-and-feedback">Support</a> •
Expand All @@ -17,35 +18,31 @@
<a href="#licensing">Licensing</a>
</p>

- [ ] TODO
## About

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

The issuer backend is accessed by the [issuer web frontend](https://github.com/eu-digital-green-certificates/dgca-issuance-web) and the respective wallet apps ( [Android](https://github.com/eu-digital-green-certificates/dgca-wallet-app-android), [iOS](https://github.com/eu-digital-green-certificates/dgca-wallet-app-ios) ) of the same member state. The backend itself publishes its public keys to the [DGCG](https://github.com/eu-digital-green-certificates/dgc-gateway) where they can be distributed to other member states. Each member state hosts its own issuer backend. The main function of the backend is to provide services for creating and signing new green certificates.

## 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 7c2f4cd

Please sign in to comment.