Update README for building, running, and testing

Author: ErikAtSumo

README.md

@@ -12,64 +12,90 @@ The Terraform Sumo Logic provider is a plugin for Terraform that allows for the
 
 This provider is maintained by Sumo Logic.
 
+## Prerequisites
+
+- [Terraform](https://www.terraform.io/downloads.html) >= 0.13
+- [Go](https://golang.org/doc/install) >= 1.13 (to build the provider plugin)
+  - Set [`$GOPATH`](http://golang.org/doc/code.html#GOPATH)
+  - Add `$GOPATH/bin` to your `$PATH`
+- [Sumo Logic](https://www.sumologic.com/)
+
 ## Getting started
 
-[Using the provider](https://www.terraform.io/docs/providers/sumologic/)
+Add the Sumo Logic provider to your terraform configuration:
 
-Run `terraform init` to automatically install the latest version of the provider.
+```
+terraform {
+    required_providers {
+        sumologic = {
+            source = "sumologic/sumologic"
+            version = "" # set the Sumo Logic Terraform Provider version
+        }
+    }
+}
+```
 
-Requirements
-------------
+Run `terraform init` to automatically install the selected version of the provider.
 
-- [Terraform](https://www.terraform.io/downloads.html) 0.12.x, 0.13x, or 0.14x
-- [Go](https://golang.org/doc/install) >= 1.13 (to build the provider plugin)
-- [Sumo Logic](https://www.sumologic.com/)
+See the [provider documentation](https://www.terraform.io/docs/providers/sumologic/) for information on the supported resources and example usage.
 
 ## Developing the provider
 
-If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine. You'll also need to correctly setup a [GOPATH](http://golang.org/doc/code.html#GOPATH), as well as adding `$GOPATH/bin` to your `$PATH`.
-
-Clone repository to: `$GOPATH/src/SumoLogic/sumologic-terraform-provider`
+### Build from source
 
 ```sh
-$ mkdir -p $GOPATH/src/SumoLogic;
-$ cd $GOPATH/src/SumoLogic
 $ git clone https://github.com/SumoLogic/terraform-provider-sumologic.git
+$ cd terraform-provider-sumologic
+$ make build
 ```
 
-Enter the provider directory and build the provider. To compile the provider, run `make build`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
+This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
+
+### Run locally-built provider
+
+- Run `make install-dev`
+- Update the provider source in your configuration file:
 
-```sh
-$ cd $GOPATH/src/SumoLogic/terraform-provider-sumologic
-$ make build
 ```
+terraform {
+  required_providers {
+    sumologic = {
+      source = "sumologic.com/dev/sumologic"
+      version = "~> 1.0.0"
+    }
+  }
+}
+```
+
+## Acceptance tests
 
-## Testing the provider
+> **Note:** Acceptance tests create real resources, and often cost money to run.
 
-In order to test the provider, you can run `make test`.
+### Configuration
 
-For manual testing, run `make install` in the root directory to install it as a plugin. 
-Then run `terraform init` to initialize it.
+Create a personal access key for your Sumo Logic account, and set the following environment variables.
 
-In order to run the full suite of Acceptance tests, run `make testacc`.
+```sh
+$ export SUMOLOGIC_ACCESSID="yourAccessID"
+$ export SUMOLOGIC_ACCESSKEY="yourAccessKey"
+$ export SUMOLOGIC_ENVIRONMENT="yourEnvironment"
+$ export SUMOLOGIC_BASE_URL="yourEnvironmentAPIUrl"  # not required for most production deployments
+$ export TF_ACC=1
+```
+
+More information on configuration can be found [here](https://github.com/SumoLogic/terraform-provider-sumologic/blob/master/website/docs/index.html.markdown#environment-variables).
 
-To run a specific acceptance test, run `go test -v ./sumologic  -run YourSpecificTestName`
+### Run the tests
 
-*Note:* 
-- Acceptance tests *create real resources*, and often cost money to run. The environment variables `SUMOLOGIC_ACCESSID`, `SUMOLOGIC_ACCESSKEY`, `SUMOLOGIC_ENVIRONMENT` / `SUMOLOGIC_BASE_URL`,  and `TF_ACC` must also be set for acceptance tests to work properly. You can generate a personal access key from your environment. Once your test runs, you are then capable of viewing the real resources created by Terraform in the UI.
-     ```sh
-     $ export SUMOLOGIC_ACCESSID="yourAccessID"
-     $ export SUMOLOGIC_ACCESSKEY="yourAccessKey"
-     $ export SUMOLOGIC_ENVIRONMENT="yourEnvironment"
-     $ export SUMOLOGIC_BASE_URL="yourEnvironmentAPIUrl"
-     $ export TF_ACC=1
-     ```
-    - More information on configuration can be found [here](https://github.com/SumoLogic/terraform-provider-sumologic/blob/master/website/docs/index.html.markdown#environment-variables).
+```sh
+# Run all acceptance tests:
+$ make testacc
+# Run a specific test:
+$ go test -v ./sumologic  -run YourSpecificTestName
+```
 
-- Environment variable `SUMOLOGIC_TEST_GOOGLE_APPLICATION_CREDENTIALS` must be set for gcp metrics acceptance tests to work properly (ex. below).
-    - export SUMOLOGIC_TEST_GOOGLE_APPLICATION_CREDENTIALS=`cat /path/to/service_acccount.json`
-    - Set Environment variable `SUMOLOGIC_ENABLE_GCP_METRICS_ACC_TESTS` to false, to disable acceptance test for Gcp Metrics. 
+Some tests require additional configuration for interacting with resources external to Sumo Logic:
 
-[0]: https://help.sumologic.com/Manage/Security/Access-Keys
-[1]: https://help.sumologic.com/APIs/General_API_Information/Sumo_Logic_Endpoints_and_Firewall_Security
-[10]: https://www.terraform.io/docs/providers/sumologic/
+- GCP metrics
+  - `export SUMOLOGIC_TEST_GOOGLE_APPLICATION_CREDENTIALS=$(cat /path/to/service_acccount.json)`
+  - `export SUMOLOGIC_ENABLE_GCP_METRICS_ACC_TESTS="false"` to disable acceptance tests