Last active
December 12, 2019 11:04
-
-
Save sleistner/fabb04c71c948f7b92f195b07df29ce1 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<!-- | |
** DO NOT EDIT THIS FILE | |
** | |
** This file was automatically generated by the `build-harness`. | |
** 1) Make all changes to `README.yaml` | |
** 2) Run `make init` (you only need to do this once) | |
** 3) Run`make readme` to rebuild this file. | |
** | |
--> | |
{{- defineDatasource "config" .Env.README_YAML | regexp.Replace ".*" "" -}} | |
{{- defineDatasource "includes" .Env.README_INCLUDES | regexp.Replace ".*" "" }} | |
[![enter-at][logo]][website] | |
# {{(ds "config").name}}{{ if gt (len (ds "config").name) 34 }}{{ print "\n\n" }}{{ end }}{{ if has (ds "config") "badges" }}{{- range $badge := (ds "config").badges -}}{{ printf " [![%s](%s)](%s)" $badge.name $badge.image $badge.url }}{{ end }}{{ end }} | |
{{ if has (ds "config") "logo" }} | |
![{{(ds "config").name}}]({{ (ds "config").logo }}) | |
{{- end -}} | |
{{ if has (ds "config") "description" }} | |
{{(ds "config").description }} | |
{{ end }} | |
--- | |
{{ if eq (ds "config").license "APACHE2" }} | |
It's 100% Open Source and licensed under the [APACHE2](LICENSE). | |
{{ end }} | |
{{ if has (ds "config") "screenshots" }} | |
## Screenshots | |
{{ range $screenshot := (ds "config").screenshots }} | |
{{ printf "![%s](%s)\n*%s*" $screenshot.name $screenshot.url $screenshot.description }}{{ end }} | |
{{ end }} | |
{{ if has (ds "config") "introduction" }} | |
## Introduction | |
{{ (ds "config").introduction -}} | |
{{ end }} | |
{{ if has (ds "config") "usage" }} | |
## Usage | |
{{ if (file.Exists "main.tf") }} | |
**IMPORTANT:** The `master` branch is used in `source` just as an example. In your code, do not pin to `master` because there may be breaking changes between releases. | |
Instead pin to the release tag (e.g. `?ref=tags/x.y.z`) of one of our [latest releases]({{ printf "https://github.com/%s/releases" (ds "config").github_repo}}). | |
{{end}} | |
{{ (ds "config").usage -}} | |
{{ end }} | |
{{ if has (ds "config") "quickstart" -}} | |
## Quick Start | |
{{ (ds "config").quickstart -}} | |
{{ end }} | |
{{ if has (ds "config") "examples" }} | |
## Examples | |
{{(ds "config").examples }} | |
{{ end }} | |
{{ if has (ds "config") "include" }} | |
{{ range $file := (datasource "config").include -}} | |
{{ (include "includes" $file) }} | |
{{- end }} | |
{{- end }} | |
{{ if has (ds "config") "related" }} | |
## Share the Love | |
Like this project? Please give it a ★ on [our GitHub]({{ printf "https://github.com/%s" (ds "config").github_repo}})! (it helps us **a lot**) | |
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =) | |
## Related Projects | |
Check out these related projects. | |
{{ range $related := (ds "config").related }} | |
{{ printf "- [%s](%s) - %s" $related.name $related.url $related.description }}{{ end }} | |
{{ end}} | |
{{ if has (ds "config") "references" }} | |
## References | |
For additional context, refer to some of these links. | |
{{ range $reference := (ds "config").references }} | |
{{ printf "- [%s](%s) - %s" $reference.name $reference.url $reference.description }}{{ end }} | |
{{ end}} | |
## Help | |
**Got a question?** | |
File a GitHub [issue]({{ printf "https://github.com/%s/issues" (ds "config").github_repo}}). | |
## Contributing | |
### Bug Reports & Feature Requests | |
Please use the [issue tracker]({{ printf "https://github.com/%s/issues" (ds "config").github_repo}}) to report any bugs or file feature requests. | |
### Developing | |
If you are interested in being a contributor and want to get involved in developing this project, we would love to hear from you! | |
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. | |
1. **Fork** the repo on GitHub | |
2. **Clone** the project to your own machine | |
3. **Commit** changes to your own branch | |
4. **Push** your work back up to your fork | |
5. Submit a **Pull Request** so that we can review your changes | |
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request! | |
{{ if has (ds "config") "copyrights" }} | |
## Copyrights | |
{{ range $copyright := (ds "config").copyrights -}} | |
{{ printf "Copyright © %s-%d [%s](%s)\n" $copyright.year time.Now.Year $copyright.name $copyright.url }} | |
{{ end }} | |
{{ end }} | |
{{ if eq (ds "config").license "APACHE2" }} | |
## License | |
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | |
See [LICENSE](LICENSE) for full details. | |
Licensed to the Apache Software Foundation (ASF) under one | |
or more contributor license agreements. See the NOTICE file | |
distributed with this work for additional information | |
regarding copyright ownership. The ASF licenses this file | |
to you under the Apache License, Version 2.0 (the | |
"License"); you may not use this file except in compliance | |
with the License. You may obtain a copy of the License at | |
https://www.apache.org/licenses/LICENSE-2.0 | |
Unless required by applicable law or agreed to in writing, | |
software distributed under the License is distributed on an | |
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
KIND, either express or implied. See the License for the | |
specific language governing permissions and limitations | |
under the License. | |
{{ end }} | |
{{ if has (datasource "config") "contributors" }} | |
### Contributors | |
| {{ range $contributor := (ds "config").contributors }}{{ printf " [![%s][%s_avatar]][%s_homepage]<br/>[%s][%s_homepage] |" $contributor.name $contributor.github $contributor.github $contributor.name $contributor.github}}{{ end }} | |
|{{- range $contributor := (ds "config").contributors -}}---|{{ end }} | |
{{ range $contributor := (ds "config").contributors -}} | |
{{- if has $contributor "homepage" }} | |
{{ printf " [%s_homepage]: %s" $contributor.github $contributor.homepage }} | |
{{ else -}} | |
{{ printf " [%s_homepage]: https://github.com/%s" $contributor.github $contributor.github }} | |
{{ end -}} | |
{{ if has $contributor "avatar" }}{{ printf " [%s_avatar]: %s" $contributor.github $contributor.avatar }} | |
{{- end }} | |
{{ end }} | |
{{ end }} | |
[logo]: https://res.cloudinary.com/enter-at/image/upload/v1576145406/static/logo.svg | |
[website]: https://github.com/enter-at |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment