Add usage instructions

Fixes #25
This commit is contained in:
Paul Tyng
2020-05-04 09:33:48 -04:00
committed by GitHub
parent 9b27e651c3
commit d43f0e56be

View File

@@ -6,6 +6,14 @@ This is very much WIP, just adding functionality as I need it for my local setup
Functionality first needs to be added to the [go-unifi](https://github.com/paultyng/go-unifi) SDK.
## Using the Provider
You can download a pre-built binary from the [releases](https://github.com/paultyng/terraform-provider-unifi/releases) page, these are built using [goreleaser](https://goreleaser.com/) (the [configuration](.goreleaser.yml) is in the repo).
If you want to build from source, you can simply use `go build` in the root of the repository.
To use an external provider binary with Terraform ([until the provider registry is GA](https://www.hashicorp.com/blog/announcing-providers-in-the-new-terraform-registry/)), you need to place the binary in a [plugin location for Terraform](https://www.terraform.io/docs/configuration/providers.html#third-party-plugins) to find it.
## Examples
### Clients (Users) with optional fixed IPs from CSV