Closed
Description
Epic: #33
The initial content of the renewed project repository README.md
and CHANGELOG.md
files will contain the SVG hero and badges provided by the great shields.io project. They will make use to the available query parameters to style and customize the badges which come closest to Arctic Ice Studio's design.
Additionally the README will provide information how to contribute to the project and the CHANGELOG includes a template for future version entries.
Further documentations about the design concept, architecture and technologies as well as guides for contributions to develop, run and maintain the project will be documented later on.
Tasks
- Create project repository hero using GitHub's new
sanitize=true
query parameter to allow rendering SVG's hosted within the repository and served via theraw.githubusercontent
subdomain. - Add shields.io badges for
- latest GitHub release version and changelog
- Circle CI build and Codecov status
- used style guide versions