Add README.md

stefansundin · Nov 25, 2017 · ba62ab7 · ba62ab7
1 parent c02e505
commit ba62ab7
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+### terraform-provider-ssh
+
+This provider enables SSH port forwarding in Terraform. It is intended as a
+bandaid [until it is supported in Terraform itself](https://github.com/hashicorp/terraform/issues/8367).
+
+#### Example
+
+See [main.tf](main.tf).
+
+#### TODO
+
+- Support another hop (ProxyJump-like behavior)
+- Note that the Windows binary is completely untested!