Readme files

Information to add to a README.md

• Title, e.g. # OPAL Civet
• Small description, e.g. OPAL metadata quality component.
  Can also include links to integrated components or links to components which are using the current component.
• Configuration
  How to configure the component, e.g.
  • Creation of a .env file including the required variables
  • Dependencies to add into a Maven pom.xml file
• Example (How to use)
  • For configurations:
    All possible keys and examples for possible values
    If provided, URLs to use the component
  • For programs: Example input, run commands, example output
• Optional: Notes, e.g. if additional information is in a wiki
• Credits

## Credits

[Data Science Group (DICE)](https://dice-research.org/) at [Paderborn University](https://www.uni-paderborn.de/)

This work has been supported by the German Federal Ministry of Transport and Digital Infrastructure (BMVI) in the project [Open Data Portal Germany (OPAL)](http://projekt-opal.de/) (funding code 19F2028A).

Examples

• Java component: Civet
• Docker component: Demo