README

Relates-to: hashicorp#14736
leesutcliffe · Nov 24, 2022 · 2c752f7 · 2c752f7
1 parent 29877ec
commit 2c752f7
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/internal/tools/generator-schema-snapshot/README.md b/internal/tools/generator-schema-snapshot/README.md
@@ -0,0 +1,19 @@
+## Schema Snapshot Generator
+
+This application generates the schema snapshot for a resource, mainly to be used for [resource state migration](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/state-migration).
+
+## Example Usage
+
+```
+$ go run main.go <resource_type>
+```
+
+E.g.
+
+```
+$ go run main.go azurerm_resource_group
+```
+
+## Arguments
+
+* `resource_type`: The resource type to generate the schema.