From ecf535cfb6091b296a30a80c35bf5f9fc018d083 Mon Sep 17 00:00:00 2001 From: Vahe Sahakyan Date: Mon, 27 Nov 2023 23:41:16 +0100 Subject: [PATCH] chore: update README --- README.md | 40 ++++------------------------------------ 1 file changed, 4 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 0f4eff2..cbb352b 100644 --- a/README.md +++ b/README.md @@ -24,41 +24,9 @@ pnpm add -D @cloudventure/sdf ### Bundler -`Bundler` is an abstract class for defining the source code or docker image of [Lambda](#lambda) functions. +`Bundler` is a construct for bundling the code for [Lambda](#lambda) functions. -Currently there are two bundler available: +Currently supported languages are: `typescript` and `custom`. +Currently supported bundiling methods are: `none`, `direct`, `s3` and `docker`. -- `BundlerTypeScript` class for TypeScript lambda function. -- `BundlerDocker` class for dockerized lambda functions. - -#### TypeScript - -`BundlerTypeScript` class is a bundler for TypeScript language. It include code generation routines which takes care -of generating the boilerplate code for entry-points and automatically links them to AWS HTTP API routes. - -### Resource - -Resources encapsulate cloud resources (S3 Buckets, DynamoDB tables, etc.) and they can be attached to Lambda functions. - -Resources pass parameters to Lambda functions through environment variables and attach IAM policies to the function to allows access to the resource. - -Resources are available to all Lambdas withing the same TerraformStack. - -### Lambda - -`Lambda` class is a convinient class for defining a lambda functions within SDF applications. - -### API - -`HttpApi` class consumes OpenAPI specification and provides: - -- generation of entrypoints based on OpenAPI paths -- generation of validators based on OpenAPI parameter and body specification -- AWS HTTP API definition -- AWS Lambda functions and related resources definition -- interfaces file generation based on OpenAPI specs -- resource configuration getters - -## Examples - -- [AWS HTTP API with Lambda Authorizer](./examples/api-lambda-auth/) +TBD