Add main readme

nota · Dec 12, 2024 · b2c8229 · b2c8229
1 parent 803d702
commit b2c8229
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 41 deletions.
diff --git a/pkgs/docs/README.md b/pkgs/docs/README.md
diff --git a/readme.md b/readme.md
@@ -0,0 +1,10 @@
+# typed-api-spec monorepo
+
+* pkgs/typed-api-spec
+  * main module of the typed-api-spec package
+  * It can be installed via `npm install @notainc/typed-api-spec`
+* pkgs/docs
+  * documentation for the typed-api-spec package
+  * hosted on nota.github.io/typed-api-spec/
+* pkgs/examples
+  * examples of using the typed-api-spec package