PROJECT
{LOGO - if available}
Short description what it is and for what you can use it and why.
Mention if there's some tools (internal or external) that it works especially well together with.
Prerequisites
Getting Project
Download the latest release: https://github.com/giantswarm/example-opensource-repo/releases/latest
Clone the git repository: https://github.com/giantswarm/example-opensource-repo.git
Download the latest docker image from here: https://hub.docker.com/r/giantswarm/example-opensource-repo/
How to build
Dependencies
Dependencies are managed using dep
and contained in the vendor
directory.
Building the standard way
go build
Cross-compiling in a container
Here goes the documentation on compiling for different architectures from inside a Docker container.
Running PROJECT
- How to use
- What does it do exactly
Further Steps
Links to documentation
Links to godoc
Future Development
Contributing & Reporting Bugs
See .github/CONTRIBUTING.md for details on submitting patches, the contribution workflow as well as reporting bugs.
For security issues, please see the security policy.
License
PROJECT is under the Apache 2.0 license. See the LICENSE file for details.