Add readme

twobiers · Sep 6, 2024 · e7f25bb · e7f25bb
1 parent 3fd2600
commit e7f25bb
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,11 @@
 # function-sdk-typescript
+
+A Node.js / TypeScript SDK for writing [composition functions][functions].
+
+This SDK is currently a alpha. It has been created out of curiosity if it's a good idea to 
+write composition functions in TypeScript and to asses the options it provides.
+
+If you just want to jump in and get started, consider using the [function-template-typescript] 
+template repository.
+
+[function-template-typescript]: https://github.com/twobiers/function-template-typescript