From 01e3617124a99e26a27c7d860d4a84394cb5bf72 Mon Sep 17 00:00:00 2001
From: Chris Rybicki <chrisr@monada.co>
Date: Fri, 14 Jun 2024 16:54:58 -0400
Subject: [PATCH] document singleton pattern

---
 tf/README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/tf/README.md b/tf/README.md
index 1eb57a15..2ac4bc76 100644
--- a/tf/README.md
+++ b/tf/README.md
@@ -162,6 +162,29 @@ And the output will be:
 }
 ```
 
+You can create a singleton provider like so:
+
+```js
+class DnsimpleProvider {
+  pub static getOrCreate(scope: std.IResource): tf.Provider {
+    let root = nodeof(scope).root;
+    let singletonKey = "WingDnsimpleProvider";
+    let existing = root.node.tryFindChild(singletonKey);
+    if existing? {
+      return unsafeCast(existing);
+    }
+
+    return new tf.Provider(
+      name: "dnsimple",
+      source: "dnsimple/dnsimple",
+      version: "1.6.0",
+    ) as singletonKey in root;
+  }
+}
+```
+
+Use `DnsimpleProvider.getOrCreate(scope)` to get the provider instance.
+
 ## Maintainers
 
 * [Elad Ben-Israel](@eladb)