chore(tools): update README for spec2cdk with an example

aws / aws-cdk

The AWS Cloud Development Kit is a framework for defining cloud infrastructure in code

https://aws.amazon.com/cdk

Apache License 2.0

11.68k stars 3.93k forks source link

chore(tools): update README for spec2cdk with an example #31935

Closed iph closed 2 weeks ago

iph commented 2 weeks ago

Without an example, it feels very difficult to use spec2cdk as you need a --service in order for the tool to pick up the temporary-schemas.

Issue # (if applicable)

Not applicable

Reason for this change

Just a usability clarification.

Description of changes

I've updated only the README

Description of how you validated changes

I read the changes in preview for markdown.

Checklist

[x] My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

mrgrain commented 2 weeks ago

@mergify update

mergify[bot] commented 2 weeks ago

update

✅ Branch has been successfully updated

aws-cdk-automation commented 2 weeks ago

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 311e21ec05793e01f996e4e5b624a802b57d2bf6
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify[bot] commented 2 weeks ago

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

github-actions[bot] commented 2 weeks ago

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.