readme.md.template

# {{.RepoName}}

> {{.Repo.Description}}

<div align="center">
<a 
    href="https://github.com/{{.Author}}/{{.RepoName}}/blob/main/go.mod#L3" style="display: inline">
    <img 
        alt="Go Version" 
        src="https://img.shields.io/github/go-mod/go-version/{{.Author}}/{{.RepoName}}?style=flat&logo=go">
</a>
<a 
    href="https://github.com/{{.Author}}/{{.RepoName}}/actions/workflows/go.yml" 
    style="display: inline"> 
    <img 
        alt="Tests Status" 
        src="https://img.shields.io/github/workflow/status/{{.Author}}/{{.RepoName}}/Test/main?style=flat&label=Tests&logo=github">
</a>
<a 
    href="https://codeclimate.com/repos/{{.CC_REPO_ID}}/test_coverage"
    style="display: inline">
    <img alt="Test Coverage"  
        src="https://api.codeclimate.com/v1/badges/{{.CC_BADGE}}/test_coverage" />
</a>
<a 
    href="https://codeclimate.com/repos/{{.CC_REPO_ID}}/maintainability"
    style="display: inline">
    <img alt="Code Climate Maintainability" 
        src="https://api.codeclimate.com/v1/badges/{{.CC_BADGE}}/maintainability" 
    />
</a>
<a 
    href="https://pkg.go.dev/github.com/{{.Author}}/{{.RepoName}}" 
    style="display: inline"> 
    <img 
        alt="Docs" 
        src="https://img.shields.io/badge/Docs-go.dev-blue?logo=go&logoColor=white&style=flat">
</a>
</div>



# Documentation

* See [examples](examples_test.go) of use.
* Read the API docs on [go.dev](https://pkg.go.dev/github.com/{{.Author}}/{{.RepoName}}).

# Contributing

* Pull request are welcome!
* Open an issue if you find a bug.
* If you want to request a new feature or need help, starts a [new discussion](https://github.com/{{.Author}}/{{.RepoName}}/discussions/new).
* Read [contribution guidelines](contributing.md).

# License
[MIT Licensed](LICENSE)

© 2021 {{.User.Name}}