first pass at the README (#50)

* doc: update readme BIPS-10308

---------

Co-authored-by: Dusty Majure <[email protected]>
Co-authored-by: djurybt <[email protected]>

README.md

@@ -2,54 +2,48 @@
     <img src="images/beyondtrust_logo.svg" alt="BeyondTrust" title="BeyondTrust" align="right" height="50">
 </a>
 
-[![Scanned by Frogbot](https://raw.github.com/jfrog/frogbot/master/images/frogbot-badge.svg)](https://github.com/jfrog/frogbot#readme)
+# BeyondTrust Password Safe Terraform Provider
+The [BeyondTrust Password Safe Terraform Provider](https://registry.terraform.io/providers/BeyondTrust/passwordsafe/latest/docs) allows [Terraform](https://terraform.io) to manage access to resources in Password Safe.  Terraform configuration files can be configured to retrieve secrets from Password Safe and permissions for access to secrets in Password Safe can be granted to specific accounts within BeyondInsight.
 
-# Password Safe Terraform Provider
-The Password Safe Terraform provider is a Terraform integration for Password Safe which enables using Password Safe secrets management capabilities with Terraform.
+## Build Requirements
+If you wish to build this project locally, please complete the following steps.
 
-Terraform configuration files can be configured to retrieve secrets from Password Safe.
+1. Install Go.  Instructions are on [their website](https://go.dev/doc/install).
+1. Install Terraform.  Instructions are on [their website](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli).
 
- Permissions for access to secrets in Password Safe can be granted to specific accounts within BeyondInsight.
-
-## Set up project
-- Install Go: [https://go.dev/doc/install](https://go.dev/doc/install)
-- Install Terraform: [https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli)
-
-- Clone Repository
+1. Clone this repository.
 
     ```bash
-    git clone https://dev.azure.com/beyondtrust/BT/_git/passwordsafe-integrations-terraform
+    git clone https://github.com/BeyondTrust/terraform-provider-passwordsafe
     ```
 
-- Generate Provider Binary File from passwordsafe-integrations-terraform folder
+1. Generate the provider binary file from passwordsafe-integrations-terraform folder.
 
     ```bash
-    go build -o terraform-provider-passwordsafe_1.0.0
+    go build -o terraform-provider-passwordsafe_major_minor_build
     ```
-- Move Binary file to proper folder to be recognized by Terraform
 
-    On widows Path looks like:
-
-    _C:\Users\<username>\AppData\Roaming\terraform.d\plugins\providers\beyondtrust\passwordsafe\1.0.0\windows_amd64_
-
-- To run unit tests you can use:
+
+    To run unit tests you can use:
 
     ```bash
    go test ./...
     ```
 
-- Update _terraform/main.tf_ and _terraform/terraform.tfvars_ files according to your needs and configs and run terraform commands:
+1. Move the binary file to the proper directory to be recognized by Terraform.
+
+1. Update _terraform/main.tf_ and _terraform/terraform.tfvars_ files according to your needs, and then run terraform commands.
 
     ```bash
     terraform init
     terraform plan
     ```
 
 ## Usage
-- please refer to the [Documentation](https://www.beyondtrust.com/docs/beyondinsight-password-safe/)
+The [product documentation](https://www.beyondtrust.com/docs/beyondinsight-password-safe/) as well as the Terraform-specific [usage documentation](https://www.beyondtrust.com/docs/beyondinsight-password-safe/ps/integrations/terraform/index.htm) are hosted on our website.
 
 ## License
-- Distributed under the GNU General Public License (GPL) v3.0 License. See `LICENSE.txt` for more information.
+This software is distributed under the GNU General Public License (GPL) v3.0 License. See `LICENSE.txt` for more information.
 
 ## Get Help
-- Contact [BeyondTrust support](https://www.beyondtrust.com/docs/index.htm#support)
+Contact [BeyondTrust support](https://www.beyondtrust.com/docs/index.htm#support)