From e7f25bb5b5eddd43389be4af43c9b34b67e4791a Mon Sep 17 00:00:00 2001 From: twobiers <22715034+twobiers@users.noreply.github.com> Date: Fri, 6 Sep 2024 23:44:32 +0200 Subject: [PATCH] Add readme --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 941c682..4e523bd 100644 --- 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