docs: update readme with logos and subsections (#235)

* docs(readme): add tf, xw and docker logo
* docs: new logo alignment
This commit is contained in:
Manuel Vogel 2021-06-23 17:33:00 +02:00 committed by GitHub
parent 82164a885c
commit 33b29dcc43
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 28 additions and 3 deletions

View file

@ -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/)

View file

@ -1,4 +1,14 @@
# Terraform Provider
<a href="https://docker.com">
<img src="https://raw.githubusercontent.com/kreuzwerker/terraform-provider-docker/master/assets/docker-logo.png" alt="Docker logo" title="Docker" align="right" height="100" />
</a>
<a href="https://terraform.io">
<img src="https://raw.githubusercontent.com/kreuzwerker/terraform-provider-docker/master/assets/terraform-logo.png" alt="Terraform logo" title="Terraform" align="right" height="100" />
</a>
<a href="https://kreuzwerker.de">
<img src="https://raw.githubusercontent.com/kreuzwerker/terraform-provider-docker/master/assets/xw-logo.png" alt="Kreuzwerker logo" title="Kreuzwerker" align="right" height="100" />
</a>
# 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).

BIN
assets/docker-logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

BIN
assets/terraform-logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.5 KiB

BIN
assets/xw-logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB