diff --git a/README.md b/README.md index 3555ea9..1018b5e 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,11 @@ # SaaS Builder Toolkit for AWS - +![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/packages/@cdklabs/sbt-aws)](https://constructs.dev/packages/@cdklabs/sbt-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. @@ -19,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. @@ -37,11 +27,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 @@ -115,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)