search

awslabs / sbt-aws

SaaS Builder Toolkit for AWS is a developer toolkit to implement SaaS best practices and increase developer velocity.
Apache License 2.0
90 stars 16 forks source link

docs: Minor ReadMe updates #13

Closed tobuck-aws closed 3 months ago

tobuck-aws commented 3 months ago

Issue # (if applicable)

Reason for this change

The Getting Started guide was out of date with latest code base.

Description of changes

Updated example code to correlate with the latest version of the component.

Description of how you validated changes

I manually ran through the getting started steps

Checklist

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.

suhussai commented 3 months ago

To safeguard against future breaking changes, do you think we should pin the version in the readme install command:

npm install @cdklabs/sbt-aws

I think this should work:

npm install @cdklabs/sbt-aws@0.0.16
tobuck-aws commented 3 months ago

Yeah, that's a great idea. I'll change that.