update readme

astronomer · Apr 3, 2024 · af214ba · af214ba
1 parent 9e7ee52
commit af214ba
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -29,6 +29,7 @@ website/vendor
 examples/main.tf
 test_results
 vendor/
+.terraformrc
 
 # Test exclusions
 !command/test-fixtures/**/*.tfstate

diff --git a/README.md b/README.md
@@ -59,6 +59,18 @@ In order to run the full suite of Acceptance tests, run `make testacc`.
 
 *Note:* Acceptance tests create real resources, and often cost money to run.
 
+To run terraform with the provider, create a `.terraformrc` file in your home directory with the following content to override the provider installation with the local build:
+
+```hcl
+provider_installation {
+  dev_overrides {
+    "registry.terraform.io/astronomer/astronomer" = "~/astronomer/astronomer-terraform-provider/bin" # Path to the provider binary
+  }
+direct {}
+}
+```
+
+
 ```shell
 make testacc
 ```