From 3dc3d822bb972768eb922ed104e1d62871ee2076 Mon Sep 17 00:00:00 2001 From: Roger Chappel Date: Wed, 15 Jul 2026 21:57:33 +1000 Subject: [PATCH] Document limitations and safety boundaries --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index d489c36..c2defa1 100644 --- a/README.md +++ b/README.md @@ -131,6 +131,13 @@ npm run build npm test ``` +## Limitations and Safety + +- TypeScript type coverage auditor — find the holes without compiling; it is intended for local, reviewable developer workflows rather than unattended production automation. +- Review generated output before using it in commits, releases, issue updates, or connector actions. +- Avoid passing secrets, private customer data, or unredacted logs through fixtures, examples, or command output. +- Treat warnings and non-zero exits from `typegap` as review signals, then rerun the documented verification command after changes. + ## License MIT © [Roger Chappel](https://github.com/rogerchappel)