diff --git a/README.md b/README.md index b3fa7ddcd..eedbb88b5 100644 --- a/README.md +++ b/README.md @@ -1 +1,22 @@ -# replace this \ No newline at end of file +# AWS CDK CLI + +Command line tools for interacting with AWS CDK applications. + +> [!NOTE] +> Packages in this repository [used to live](https://github.com/aws/aws-cdk/commit/8b87a637d5ce627ebb23637e853558a9ae545b9f) in the +> main `aws-cdk` repository and were moved here following the decision to split the construct +> library from the CLI. +> +> See [AWS CDK is splitting Construct Library and CLI](https://aws.amazon.com/blogs/opensource/aws-cdk-is-splitting-construct-library-and-cli/) + +## Packages + +The main packages published from this repository are: + +- [`aws-cdk`](https://www.npmjs.com/package/aws-cdk) +- [`cdk-assets@^3`](https://www.npmjs.com/package/cdk-assets) +- [`@aws-cdk/cloud-assembly-schema`](https://www.npmjs.com/package/@aws-cdk/cloud-assembly-schema) + +## More Information + +Refer to each individual package README for more details.