diff --git a/README.md b/README.md index 0bffc398..3518eaae 100644 --- a/README.md +++ b/README.md @@ -1 +1,32 @@ -CovidCertificate-App-Verifier-Service +# CovidCertificate-App-Verifier-Service + +[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://github.com/admin-ch/CovidCertificate-App-Verifier-Service/blob/main/LICENSE) + +This project is released by the the [Federal Office of Information Technology, Systems and Telecommunication FOITT](https://www.bit.admin.ch/) +on behalf of the [Federal Office of Public Health FOPH](https://www.bag.admin.ch/). +The app design, UX and implementation was done by [Ubique](https://www.ubique.ch?app=github). + +## Services + +TODO write a few words, like in https://github.com/admin-ch/CovidCertificate-App-Config-Service/blob/main/README.md + +## Contribution Guide + +This project is truly open-source and we welcome any feedback on the code regarding both the implementation and security aspects. + +Bugs or potential problems should be reported using Github issues. +We welcome all pull requests that improve the quality of the source code. +Please note that the app will be available with approved translations in English, German, French, Italian. + +## Repositories + +* Android App: [CovidCertificate-App-Android](https://github.com/admin-ch/CovidCertificate-App-Android) +* Android SDK: [CovidCertificate-SDK-Android](https://github.com/admin-ch/CovidCertificate-SDK-Android) +* iOS App: [CovidCertificate-App-iOS](https://github.com/admin-ch/CovidCertificate-App-iOS) +* iOS SDK: [CovidCertificate-SDK-iOS](https://github.com/admin-ch/CovidCertificate-SDK-iOS) +* Config Service: [CovidCertificate-App-Config-Service](https://github.com/admin-ch/CovidCertificate-App-Config-Service) +* Verifier Service: [CovidCertificate-App-Verifier-Service](https://github.com/admin-ch/CovidCertificate-App-Verifier-Service) + +## License + +This project is licensed under the terms of the MPL 2 license. See the [LICENSE](LICENSE) file for details.