diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 47389703..452b01fe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ Please use issue templates as much as possible. Prerequisites: - `make`, `git`, `bash` -- [Go 1.15+](https://golang.org/doc/install) +- [Go 1.16+](https://golang.org/doc/install) - [Docker](https://www.docker.com/) - [Terraform 0.12+](https://terraform.io/) diff --git a/README.md b/README.md index 992fc973..e069e426 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,14 @@ -# Terraform Provider + + Docker logo + + + Terraform logo + + + Kreuzwerker logo + + +# Terraform Provider for Docker - Website: https://www.terraform.io - Provider: [kreuzwerker/docker](https://registry.terraform.io/providers/kreuzwerker/docker/latest) @@ -7,7 +17,7 @@ ## Requirements - [Terraform](https://www.terraform.io/downloads.html) >=0.12.x -- [Go](https://golang.org/doc/install) 1.15.x (to build the provider plugin) +- [Go](https://golang.org/doc/install) 1.16.x (to build the provider plugin) ## Building The Provider @@ -17,6 +27,11 @@ $ make build ``` ## Example usage + +Take a look at the examples in the [documentation](https://registry.terraform.io/providers/kreuzwerker/docker/2.13.0/docs) of the registry +or use the following example: + + ```hcl # Set the required provider and versions terraform { @@ -77,3 +92,13 @@ resource "docker_service" "nginx_service" { } } ``` + +## Contributing + +The Terraform Docker Provider is the work of many of contributors. We appreciate your help! + +To contribute, please read the contribution guidelines: [Contributing to Terraform - Docker Provider](CONTRIBUTING.md) + +## License + +The Terraform Provider Docker is available to everyone under the terms of the Mozilla Public License Version 2.0. [Take a look the LICENSE file](LICENSE). \ No newline at end of file diff --git a/assets/docker-logo.png b/assets/docker-logo.png new file mode 100644 index 00000000..2c5d0f07 Binary files /dev/null and b/assets/docker-logo.png differ diff --git a/assets/terraform-logo.png b/assets/terraform-logo.png new file mode 100644 index 00000000..7f0bb0f4 Binary files /dev/null and b/assets/terraform-logo.png differ diff --git a/assets/xw-logo.png b/assets/xw-logo.png new file mode 100644 index 00000000..57eaad8a Binary files /dev/null and b/assets/xw-logo.png differ