From 9401974652723ad3984b24826ec356c6c2e86147 Mon Sep 17 00:00:00 2001 From: Prasad Jivane Date: Sun, 3 Jul 2022 21:20:59 +0530 Subject: [PATCH 1/2] README.md Updated Updated README.md typo fixes. --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5d77b66a3b..5032903ab9 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,9 @@ [Installation](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) | [Blogs](https://serverlessland.com/blog?tag=AWS%20SAM) | [Videos](https://serverlessland.com/video?tag=AWS%20SAM) | [AWS Docs](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html) | [Roadmap](https://github.com/aws/aws-sam-cli/wiki/SAM-CLI-Roadmap) | [Try It Out](https://s12d.com/Tq9ZE-Br) The AWS Serverless Application Model (SAM) CLI is an open-source CLI tool that helps you develop serverless applications containing [Lambda functions](https://aws.amazon.com/lambda/), [Step Functions](https://aws.amazon.com/step-functions/), [API Gateway](https://aws.amazon.com/api-gateway/), [EventBridge](https://aws.amazon.com/eventbridge/), [SQS](https://aws.amazon.com/sqs/), [SNS](https://aws.amazon.com/sns/) and more. Some of the features it provides are: -- **Initialize serverless applications** in minutes with AWS provided infrastructure templates with `sam init` -- **Compile, build, and package** Lambda functions with provided runtimes and with custom Makefile workflows, for zip and image types of Lambda functions with `sam build` -- **Locally test** a Lambda function and API Gateway easily in a Docker container with `sam local` commands on SAM and CDK applications +- **Initialize serverless applications** in minutes with AWS-provided infrastructure templates with `sam init` +- **Compile, build, and package** Lambda functions with provided runtimes and with custom Makefile workflows, for zipping and image types of Lambda functions with `sam build` +- **Locally test** a Lambda function and API Gateway quickly in a Docker container with `sam local` commands on SAM and CDK applications - **Sync and test your changes in the cloud** with `sam sync` in your developer environments - **Deploy** your SAM and CloudFormation templates using `sam deploy` - Quickly **create pipelines** with prebuilt templates with popular CI/CD systems using `sam pipeline init` @@ -33,16 +33,16 @@ environment that lets you locally build, test, debug, and deploy [AWS serverless **Next Steps:** Learn to build a more complex serverless application. -* [Extract text from images and store in a database](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-example-s3.html) using Amazon S3 and Amazon Rekognition services. -* [Detect when records are added to a database](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-example-ddb.html) using Amazon DynamoDB database and asynchronous stream processing. +* [Extract text from images and store it in a database](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-example-s3.html) using Amazon S3 and Amazon Rekognition services. +* [Detect when records added to a database](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-example-ddb.html) using Amazon DynamoDB database and asynchronous stream processing. * [Explore popular patterns](https://serverlessland.com/patterns) ## What is this Github repository? 💻 -This Github Repository contains source code for SAM CLI. Here is the development team talking about this code: +This Github repository contains source code for SAM CLI. Here is the development team talking about this code: > SAM CLI code is written in Python. Source code is well documented, very modular, with 95% unit test coverage. -It uses this awesome Python library called Click to manage the command line interaction and uses Docker to run Lambda functions locally. +It uses this excellent Python library called Click to manage the command line interaction and uses Docker to run Lambda functions locally. We think you'll like the code base. Clone it and run `make pr` or `./Make -pr` on Windows! @@ -70,17 +70,16 @@ to get started. **Strengthen SAM CLI** -Add new commands or enhance existing ones, report bugs, or request new features for the SAM CLI. +Add new commands, enhance existing ones, report bugs, or request new features for the SAM CLI. Source code is located on Github at [awslabs/aws-sam-cli](https://github.com/awslabs/aws-sam-cli). Read the [SAM CLI Contributing Guide](https://github.com/awslabs/aws-sam-cli/blob/develop/CONTRIBUTING.md) to get started. **Update SAM Developer Guide** -[SAM Developer Guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/index.html) provides comprehensive getting started guide and reference documentation. +[SAM Developer Guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/index.html) provides a comprehensive getting started guide and reference documentation. Source code is located on Github at [awsdocs/aws-sam-developer-guide](https://github.com/awsdocs/aws-sam-developer-guide). Read the [SAM Documentation Contribution Guide](https://github.com/awsdocs/aws-sam-developer-guide/blob/master/CONTRIBUTING.md) to get started. ### Join the SAM Community on Slack [Join the SAM developers channel (#samdev)](https://join.slack.com/t/awsdevelopers/shared_invite/zt-idww18e8-Z1kXhI7GNuDewkweCF3YjA) on Slack to collaborate with fellow community members and the AWS SAM team. - From 5e2c98b892af744fdc23f46487ee5d6388d6fcaa Mon Sep 17 00:00:00 2001 From: Prasad Jivane Date: Mon, 4 Jul 2022 00:34:19 +0530 Subject: [PATCH 2/2] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5032903ab9..75e19c137c 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ The AWS Serverless Application Model (SAM) CLI is an open-source CLI tool that helps you develop serverless applications containing [Lambda functions](https://aws.amazon.com/lambda/), [Step Functions](https://aws.amazon.com/step-functions/), [API Gateway](https://aws.amazon.com/api-gateway/), [EventBridge](https://aws.amazon.com/eventbridge/), [SQS](https://aws.amazon.com/sqs/), [SNS](https://aws.amazon.com/sns/) and more. Some of the features it provides are: - **Initialize serverless applications** in minutes with AWS-provided infrastructure templates with `sam init` -- **Compile, build, and package** Lambda functions with provided runtimes and with custom Makefile workflows, for zipping and image types of Lambda functions with `sam build` -- **Locally test** a Lambda function and API Gateway quickly in a Docker container with `sam local` commands on SAM and CDK applications +- **Compile, build, and package** Lambda functions with provided runtimes and with custom Makefile workflows, for zip and image types of Lambda functions with `sam build` +- **Locally test** a Lambda function and API Gateway easily in a Docker container with `sam local` commands on SAM and CDK applications - **Sync and test your changes in the cloud** with `sam sync` in your developer environments - **Deploy** your SAM and CloudFormation templates using `sam deploy` - Quickly **create pipelines** with prebuilt templates with popular CI/CD systems using `sam pipeline init` @@ -34,7 +34,7 @@ environment that lets you locally build, test, debug, and deploy [AWS serverless **Next Steps:** Learn to build a more complex serverless application. * [Extract text from images and store it in a database](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-example-s3.html) using Amazon S3 and Amazon Rekognition services. -* [Detect when records added to a database](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-example-ddb.html) using Amazon DynamoDB database and asynchronous stream processing. +* [Detect when records are added to a database](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-example-ddb.html) using Amazon DynamoDB database and asynchronous stream processing. * [Explore popular patterns](https://serverlessland.com/patterns) @@ -42,7 +42,7 @@ environment that lets you locally build, test, debug, and deploy [AWS serverless This Github repository contains source code for SAM CLI. Here is the development team talking about this code: > SAM CLI code is written in Python. Source code is well documented, very modular, with 95% unit test coverage. -It uses this excellent Python library called Click to manage the command line interaction and uses Docker to run Lambda functions locally. +It uses this awesome Python library called Click to manage the command line interaction and uses Docker to run Lambda functions locally. We think you'll like the code base. Clone it and run `make pr` or `./Make -pr` on Windows!