add readme for templates

getsentry · Nov 24, 2021 · 29e7122 · 29e7122
1 parent 2f77811
commit 29e7122
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/tsconfig-templates/README.md b/tsconfig-templates/README.md
@@ -0,0 +1,5 @@
+# `tsconfig` Templates
+
+Every package should get its own copy of these four files. Package-specific options should go in `tsconfig.json` and
+test-specific options in `tsconfig.test.json`. The `cjs` and `esm` files shouldn't need to be modified, and only exist
+because tsconfigs don't support multiple inheritence.