{{- if .Project.Image -}}
{{- if .Project.Website -}}
{{- printf "" .Project.Website .Project.Image -}}
{{- else -}}
{{- printf "
" .Project.Image -}}
{{- end -}}
{{- else -}}
{{- end }} {{ "" }} {{ .Project.OneLiner }}
{{ range .Badges }}
{{- if or .Image .Link }}
{{- printf " " .Alt .Image .Link -}}
{{ end -}}
{{ end }}
{{ "" }} {{- if eq .Project.State "beta" }} {{- printf "NOTE: This is a beta release, we do not consider it completely production ready yet. Use at your own risk." -}} {{ end }}
{{- if eq .Project.State "unstable" -}} {{- printf "NOTE: This is a work-in-progress, we do not consider it production ready. Use at your own risk." -}} {{ end }}
{{ "" }} {{- if .Project.Image -}} {{- printf "# %s" .Project.Name }} {{ end -}} {{ .Project.Description -}}
{{ "" }} {{ printf "## Using %s" .Project.Name }} {{ with .Readme.UsageExample -}} {{- . -}} {{- end -}}
{{- with .SupportLinks.Documentation -}} Take a look at our full [documentation]({{ . }}). {{- end }}
For detailed information on support options see our support guide.
Best place to start is our contribution guide.
{{ if eq .Project.MainLicense "AGPLv3" }} {{- printf "Code is licensed under the %s. " (print "AGPL License, Version 3.0") }} {{ else if eq .Project.MainLicense "GPLv3" }} {{- printf "Code is licensed under the %s. " (print "GPL License, Version 3.0") }} {{ else if eq .Project.MainLicense "BSD3" }} {{- printf "Code is licensed under the %s. " (print "BSD License, Version 3.0") }} {{ else if eq .Project.MainLicense "MIT" }} {{- printf "Code is licensed under the %s. " (print "MIT License") }} {{ else }} {{- printf "Code is licensed under the %s. " (print "Apache License, Version 2.0") }} {{ end -}}
{{ if eq .Project.DocsLicense "apache2" }} {{- printf "Documentation/examples are licensed under %s. " (print "Apache License, Version 2.0") }} {{ else if eq .Project.DocsLicense "CCBy" }} {{- printf "Documentation/examples are licensed under %s. " (print "Creative Commons BY 4.0") }} {{ else if eq .Project.DocsLicense "CCSa" }} {{- printf "Documentation/examples are licensed under %s. " (print "Creative Commons SA 4.0") }} {{ else if eq .Project.DocsLicense "CCByNcSa" }} {{- printf "Documentation/examples are licensed under %s. " (print "Creative Commons BY-NC-SA 4.0") }} {{ else if eq .Project.DocsLicense "CC0" }} {{- printf "Documentation/examples are licensed under %s. " (print "Creative Commons CC0 1.0") }} {{ else }} {{- printf "Documentation/examples are licensed under %s. " (print "Creative Commons BY-SA 4.0") }} {{ end -}}
Illustrations, trademarks and third-party resources are owned by their respective party and are subject to different licensing.
{{ if .Copyright.Owner -}} {{ printf "Copyright %s - %s" .Copyright.Year .Copyright.Owner }} {{- else -}} {{ printf "Copyright %s - %s" .Copyright.Year (printf "The %s Authors" .Project.Name) }} {{ end }}