Skip to content

Commit

Permalink
README lint fixes (#319)
Browse files Browse the repository at this point in the history
  • Loading branch information
ekampf authored Apr 14, 2023
1 parent 422f0aa commit 76bda8a
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -22,36 +20,37 @@ 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=<your network slug - <slug>.twingate.com>
export TWINGATE_API_TOKEN=<API token with Read, Write & Provision permissions>
```

Then you can run by:

```shell
make testacc
```




## Install:
## Install

Install the provider for local testing.

```shell
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).

0 comments on commit 76bda8a

Please sign in to comment.