Skip to content

Commit

Permalink
Added Getting Started to README
Browse files Browse the repository at this point in the history
  • Loading branch information
joshhornby committed Nov 21, 2018
1 parent 7ffb043 commit f14d05f
Showing 1 changed file with 33 additions and 14 deletions.
47 changes: 33 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,42 @@
# Terraform Provider
# Terraform Twilio Task Router Provider

## Requirements

- [Terraform](https://www.terraform.io/downloads.html) 0.11.x

## Usage
## Getting Started

- Download the latest release from [the releases page](https://github.com/joshhornby/terraform-provider-twiliotaskrouter/releases)
- `tar -xvzf terraform-provider-twiliotaskrouter_VERSION.tgz`
- `mkdir -p ~/.terraform.d/plugins/darwin_amd64 && cp terraform-provider-twiliotaskrouter ~/.terraform.d/plugins/darwin_amd64`
Download the latest release from [the releases page](https://github.com/joshhornby/terraform-provider-twiliotaskrouter/releases)

Unzip the download

`tar -xvzf terraform-provider-twiliotaskrouter_VERSION.tgz`

We need to tell Terraform to use our customer provider, the command below will create the directory if you don't already
have it and then copy the provider into this folder.

`mkdir -p ~/.terraform.d/plugins/darwin_amd64 && cp terraform-provider-twiliotaskrouter ~/.terraform.d/plugins/darwin_amd64`

Next, create a new Terraform file `main.tf` and at the top include

```
provider "twiliotaskrouter" {
account_sid = "ACXXX"
auth_token = "XXX"
workspace_sid = "WSXXX"
}
```

This tells Terraform to use our custom provider.

The provider configuration block accepts the following arguments:

- `account_sid` - (Required) Your SID (application ID) for the the Twilio API. May alternatively be set via the
`TWILIO_SID` environment variable.
- `auth_token` - (Required) The API auth token to use when making requests. May alternatively
be set via the `TWILIO_AUTH_TOKEN` environment variable.
- `workspace_sid` - (Required) The sid of your Task Router Workspace. May alternatively
be set via the `TWILIO_WORKSPACE_SID` environment variable.

## Example

Expand Down Expand Up @@ -91,15 +119,6 @@ EOF
```

The provider configuration block accepts the following arguments:

- `account_sid` - (Required) Your SID (application ID) for the the Twilio API. May alternatively be set via the
`TWILIO_SID` environment variable.
- `auth_token` - (Required) The API auth token to use when making requests. May alternatively
be set via the `TWILIO_AUTH_TOKEN` environment variable.
- `workspace_sid` - (Required) The sid of your Task Router Workspace. May alternatively
be set via the `TWILIO_WORKSPACE_SID` environment variable.

### With Thanks

- Thanks To Kevin Burke for his help over on the [Twilio Go library](https://github.com/kevinburke/twilio-go)
Expand Down

0 comments on commit f14d05f

Please sign in to comment.