diff --git a/README.md b/README.md index cf7d38f..f006c2c 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,33 @@ -# Static Website CDK Construct +# Cloud-native Accelerator: CDK Patterns for AWS + +## Usage + +### Install + +To install this construct to your CDK project you need to run + +```bash +npm install @Accenture/cna-aws-cdk-patterns +``` + + +## Static Website CDK Construct This project contains a CDK construct for creating the infrastructure needed for hosting a static website. It also contains templates for CI/CD pipelines for deploying static content and *Single Page Applications* (SPA) to the static website infrastructure. -## Architecture +### Architecture The infrastructure for hosting consists of the following AWS services: * AWS S3 * CloudFront -* *ACM* -* *Route 53* -* *Lambda@Edge* +* ACM +* Route 53 Additionally, the CI/CD pipelines are based on the following AWS services: * CodePipeline -* *CodeBuild* - -## Usage - -### Install - -To install this construct to your CDK project you need to run - -```bash -npm install @Accenture/cna-aws-cdk-patterns -``` +* CodeBuild ### Create Static Website