diff --git a/README.md b/README.md index 8ee981d2..76b578a5 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,15 @@ -Twingate Terraform Provider -================== +# Twingate Terraform Provider [![Coverage Status](https://coveralls.io/repos/github/Twingate/terraform-provider-twingate/badge.svg?branch=main&t=rqgifB)](https://coveralls.io/github/Twingate/terraform-provider-twingate?branch=main) -Requirements ------------- +## Requirements -- Bash -- [Go](https://golang.org/doc/install) 1.19 (to build the provider plugin) -- [Terraform](https://www.terraform.io/downloads.html) 1.x +- Bash +- [Go](https://golang.org/doc/install) 1.19 (to build the provider plugin) +- [Terraform](https://www.terraform.io/downloads.html) 1.x -## Build: +## Build Run the following command to build the provider @@ -22,25 +20,26 @@ make build ## Test Run unit tests: + ```shell make test ``` To run acceptance tests against a real Twingate network you first need to define the following 3 environment variables: + ```shell export TWINGATE_URL=twingate.com export TWINGATE_NETWORK=.twingate.com> export TWINGATE_API_TOKEN= ``` + Then you can run by: + ```shell make testacc ``` - - - -## Install: +## Install Install the provider for local testing. @@ -48,10 +47,10 @@ Install the provider for local testing. make install ``` -## Documentation: +## Documentation To update the documentation edit the files in `templates/` and then run `make docs`. The files in `docs/` are auto-generated and should not be updated manually. -## Contributions: +## Contributions Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) under the [project's open source license](LICENSE).