From 639288ca95acb71c9f42be45500f4c24bac4b647 Mon Sep 17 00:00:00 2001 From: Buckley Date: Wed, 28 Feb 2024 09:15:07 -0800 Subject: [PATCH 1/4] added workflow and construct hub --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3555ea9a..9472d37c 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ [![Maven Central](https://maven-badges.herokuapp.com/maven-central/software.amazon.awscdk/aws-cdk-lib/badge.svg)](https://maven-badges.herokuapp.com/maven-central/software.amazon.awscdk/aws-cdk-lib) [![Go Reference](https://pkg.go.dev/badge/github.com/aws/aws-cdk-go/awscdk/v2.svg)](https://pkg.go.dev/github.com/aws/aws-cdk-go/awscdk/v2) [![Mergify](https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/aws/aws-cdk&style=flat)](https://mergify.io)--> - -[![View on Construct Hub](https://constructs.dev/packages/@cdklabs/sbt-aws)](https://constructs.dev/packages/@cdklabs/sbt-aws) +![build status](https://github.com/awslabs/sbt-aws/actions/workflows/release.yml/badge.svg) +[![View on Construct Hub](https://constructs.dev/badge?package=%40cdklabs%2Fsbt-aws)](https://constructs.dev/packages/@cdklabs/sbt-aws) The **SaaS Builder Toolkit for AWS** is an open-source developer toolkit to implement SaaS best practices and increase developer velocity. @@ -37,11 +37,11 @@ Jump To: ------- -SBT is built on top of the AWS Cloud Development Kit (CDK). It offers a number of higher-order constructs (L2, L2.5 and L3) to short-circuit the time required to build SaaS applications. Specifically, SBT attempts to codify several control plane and application plane concepts into reusable components, removing promoting reuse and reducing boilerplate code. +SBT is built on top of the AWS Cloud Development Kit (CDK). It offers a number of higher-order constructs (L2, L2.5 and L3) to short-circuit the time required to build SaaS applications. Specifically, SBT attempts to codify several control plane and application plane concepts into reusable components, promoting reuse and reducing boilerplate code. ## Getting Started -For a detailed walkthrough, see the [tutorial](https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html#hello_world_tutorial) in the [developer guide](https://docs.aws.amazon.com/cdk/latest/guide/home.html). +For a detailed walkthrough, see the [tutorial](https://github.com/awslabs/sbt-aws/blob/main/docs/public/README.md#tutorial) in the [developer guide](https://github.com/awslabs/sbt-aws/blob/main/docs/public/README.md). ### At a glance From 33f25953e7cec2891e6b2918a8537a88bc509bd7 Mon Sep 17 00:00:00 2001 From: Buckley Date: Wed, 28 Feb 2024 09:17:53 -0800 Subject: [PATCH 2/4] added npm status --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9472d37c..05048f17 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ [![Go Reference](https://pkg.go.dev/badge/github.com/aws/aws-cdk-go/awscdk/v2.svg)](https://pkg.go.dev/github.com/aws/aws-cdk-go/awscdk/v2) [![Mergify](https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/aws/aws-cdk&style=flat)](https://mergify.io)--> ![build status](https://github.com/awslabs/sbt-aws/actions/workflows/release.yml/badge.svg) +[![npm version](https://badge.fury.io/js/@cdklabs%2Fsbt-aws.svg)](https://badge.fury.io/js/@cdklabs%2Fsbt-aws) + [![View on Construct Hub](https://constructs.dev/badge?package=%40cdklabs%2Fsbt-aws)](https://constructs.dev/packages/@cdklabs/sbt-aws) The **SaaS Builder Toolkit for AWS** is an open-source developer toolkit to implement SaaS best practices and increase developer velocity. From 9c5956dd7889e7ad56cdb24ce0be8ceed64912a3 Mon Sep 17 00:00:00 2001 From: Buckley Date: Wed, 28 Feb 2024 11:03:45 -0800 Subject: [PATCH 3/4] removed dead comments --- README.md | 18 +----------------- 1 file changed, 1 insertion(+), 17 deletions(-) diff --git a/README.md b/README.md index 05048f17..dfcb112e 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,11 @@ # SaaS Builder Toolkit for AWS - ![build status](https://github.com/awslabs/sbt-aws/actions/workflows/release.yml/badge.svg) [![npm version](https://badge.fury.io/js/@cdklabs%2Fsbt-aws.svg)](https://badge.fury.io/js/@cdklabs%2Fsbt-aws) [![View on Construct Hub](https://constructs.dev/badge?package=%40cdklabs%2Fsbt-aws)](https://constructs.dev/packages/@cdklabs/sbt-aws) -The **SaaS Builder Toolkit for AWS** is an open-source developer toolkit to implement SaaS best practices and increase developer velocity. +The **SaaS Builder Toolkit for AWS** (SBT) is an open-source developer toolkit to implement SaaS best practices and increase developer velocity. It offers a high-level object-oriented abstraction to define SaaS resources on AWS imperatively using the power of modern programming languages. Using SBT’s library of infrastructure constructs, you can easily encapsulate SaaS best practices in your SaaS application, and share it without worrying about boilerplate logic. @@ -21,10 +13,6 @@ Currently, SBT is available in the following language: * JavaScript, TypeScript ([Node.js ≥ 14.15.0](https://nodejs.org/download/release/latest-v14.x/)) * We recommend using a version in [Active LTS](https://nodejs.org/en/about/previous-releases) - Third-party Language Deprecation: language version is only supported until its EOL (End Of Life) shared by the vendor or community and is subject to change with prior notice. @@ -117,10 +105,6 @@ The [SBT for AWS Roadmap project board](PLACEHOLDER) lets developers know about We welcome community contributions and pull requests. See [CONTRIBUTING.md](./CONTRIBUTING.md) for information on how to set up a development environment and submit code. - - ## More Resources * [SaaS on AWS](http://aws.amazon.com/saas) From d9791fcdcbc6b20b4d0a3e6a02309f5cc7250462 Mon Sep 17 00:00:00 2001 From: Buckley Date: Wed, 28 Feb 2024 11:32:32 -0800 Subject: [PATCH 4/4] changed release badge to build --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dfcb112e..1018b5eb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # SaaS Builder Toolkit for AWS -![build status](https://github.com/awslabs/sbt-aws/actions/workflows/release.yml/badge.svg) +![build status](https://github.com/awslabs/sbt-aws/actions/workflows/build.yml/badge.svg) [![npm version](https://badge.fury.io/js/@cdklabs%2Fsbt-aws.svg)](https://badge.fury.io/js/@cdklabs%2Fsbt-aws) [![View on Construct Hub](https://constructs.dev/badge?package=%40cdklabs%2Fsbt-aws)](https://constructs.dev/packages/@cdklabs/sbt-aws)