From e04e6cf6de1cd6cca4a3508599ab82a19c4fc086 Mon Sep 17 00:00:00 2001 From: Integralist Date: Tue, 24 Jan 2023 17:14:37 +0000 Subject: [PATCH] docs(README): describe local testing --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0257bb0..4d3574f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ The Fastly Terraform Provider interacts with most facets of the [Fastly API](https://developer.fastly.com/reference/api) and uses the [Terraform Plugin Framework](https://github.com/hashicorp/terraform-plugin-framework). +## Using the provider + +Consumers should refer to the [EXAMPLES](./examples/) + ## Requirements - [Terraform](https://www.terraform.io/downloads.html) >= 1.0 @@ -19,10 +23,6 @@ The Fastly Terraform Provider interacts with most facets of the [Fastly API](htt go install ``` -## Using the provider - -TODO - ## Developing the Provider We document issues with the provider in [`DEVELOPMENT.md`](./DEVELOPMENT.md). @@ -31,6 +31,8 @@ If you wish to work on the provider, you'll first need [Go](http://www.golang.or To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory. +To manually test the provider (e.g. using the provider with your own Terraform configuration), run `make build`, which runs `go install` but also produces a `~/.terraformrc` that enables the Terraform CLI to use the local build version. + To generate or update documentation, run `go generate` (or `make docs`). To run the full suite of Acceptance tests, run `make testacc`.