From 531ad8881d57d1025c0825893c134274527bfbf6 Mon Sep 17 00:00:00 2001
From: "David J. Allen" <davidallendj@gmail.com>
Date: Tue, 7 Jan 2025 12:41:35 -0700
Subject: [PATCH] readme: added note about illegal template keys

---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index d040037..4403f8c 100644
--- a/README.md
+++ b/README.md
@@ -153,6 +153,10 @@ func (g *MyGenerator) Generate(config *configurator.Config, opts ...util.Option)
   })
 }
 
+> [!NOTE]
+> The keys in `generator.ApplyTemplate` must not contain illegal characters such as a `-` or else the templates will not apply correctly.
+
+
 // this MUST be named "Generator" for symbol lookup in main driver
 var Generator MyGenerator
 ```