From d07c7e16c4df6dc3d4daa15884f3540cc2ad7895 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Gniewek-W=C4=99grzyn?= Date: Mon, 13 Jun 2022 14:48:57 +0200 Subject: [PATCH] Readme template --- README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..aab07b5 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# MODULE_NAME + + +> **Warning**: +> This is a template document. Remember to **remove** all text in _italics_ and **update** _REPO_NAME_ and _MODULE_NAME_ to the acual name of your GitHub repository/module!!! + +![AWS](https://img.shields.io/badge/AWS-%23FF9900.svg?style=for-the-badge&logo=amazon-aws&logoColor=white) +![Terraform](https://img.shields.io/badge/terraform-%235835CC.svg?style=for-the-badge&logo=terraform&logoColor=white) + +![License](https://badgen.net/github/license/getindata/REPO_NAME/) +![Release](https://badgen.net/github/release/getindata/REPO_NAME/) + +![GetInData](https://getindata.com/img/logo.svg) +
We help companies turn their data into assets
+ +_Brief Description of MODULE:_ + +* _What it does_ +* _What techonlogies it uses_ + +## USAGE + +_Example usage of the module - terraform code snippet_ + +```terraform +``` + +## EXAMPLES + +* _List of links to example implementations in [example](https://github.com/getindata/terraform-module-template/blob/main/example) repo directory_ + +## NOTES + +_Additional information that should be made public, for ex. how to solve known issues, additional descriptions/suggestions_ + + + + + +## CONTRIBUTING + +Contributions are very welcomed! + +Start by reviewing [contribution guide](CONTRIBUTING.md) and our [code of conduct](CODE_OF_CONDUCT.md). After that, start coding and ship your changes by creating a new PR. + +## LICENSE + +Apache 2 Licensed. See [LICENSE](LICENSE) for full details. + +## AUTHORS + + + + + +Made with [contrib.rocks](https://contrib.rocks). \ No newline at end of file