From cb5c493b992e8098289b5c2e62db91283e34fdc9 Mon Sep 17 00:00:00 2001 From: Markus Frosch Date: Wed, 20 Dec 2023 10:06:24 +0100 Subject: [PATCH] docs: update readme --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ae6f11..c0dcf02 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,16 @@ # Terraform Provider for Nokia QIP +![GitHub tag (with filter)](https://img.shields.io/github/v/release/Vitesco-Technologies/terraform-provider-qip) +[![Terraform Registry](https://img.shields.io/badge/Terraform_Registry-Vitesco--Technologies%2Fqip-blue)][terraform-registry] +![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/Vitesco-Technologies/terraform-provider-qip/golang.yml) +![GitHub License](https://img.shields.io/github/license/Vitesco-Technologies/terraform-provider-qip) +[![Open Source](https://img.shields.io/badge/Vitesco_Technologies-open--source-yellow)](https://github.com/Vitesco-Technologies) + + The provider for Nokia QIP will allow you to retrieve metadata from QIP or manage IPv4 addresses including their DNS names. +Documentation and releases can also be found on the [Terraform Registry under Vitesco-Technologies/qip][terraform-registry]. + Features: - Data sources for `qip_v4address` and `qip_v4subnet` @@ -15,7 +24,7 @@ Build based on the Swagger API documentation that should be available with your ## How to use -Please see the [documentation](docs/) for some examples. +Please see the [documentation on the Terraform registry][terraform-registry] for some examples. Very basic usage: @@ -74,3 +83,5 @@ Then, run the following command to initialize the workspace and apply the sample ```shell terraform init && terraform apply ``` + +[terraform-registry]: https://registry.terraform.io/providers/Vitesco-Technologies/qip/latest