-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updating README #950
Updating README #950
Conversation
Codecov Report
@@ Coverage Diff @@
## develop #950 +/- ##
========================================
Coverage 94.86% 94.86%
========================================
Files 69 69
Lines 3055 3055
Branches 573 573
========================================
Hits 2898 2898
Misses 84 84
Partials 73 73 Continue to review full report at Codecov.
|
[![Codecov Test Coverage](https://codecov.io/gh/awslabs/serverless-application-model/branch/master/graphs/badge.svg?style=flat)](https://codecov.io/gh/awslabs/serverless-application-model) | ||
|
||
![Logo](aws_sam_introduction.png) | ||
<p align="center"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't make sense.
[![Codecov Test Coverage](https://codecov.io/gh/awslabs/serverless-application-model/branch/master/graphs/badge.svg?style=flat)](https://codecov.io/gh/awslabs/serverless-application-model) | ||
|
||
![Logo](aws_sam_introduction.png) | ||
<p align="center"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Empty tag? Some sort of hack?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think so.
README.md
Outdated
|
||
This GitHub project is the starting point for AWS SAM. It contains the SAM specification, the code that translates SAM templates into AWS CloudFormation stacks, general information about the model, and examples of common applications. | ||
![Apache-2.0](https://img.shields.io/github/license/awslabs/serverless-application-model.svg) | ||
![SAM_CLI release](https://img.shields.io/github/release/awslabs/aws-sam-cli.svg) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is the SAM CLI release version here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wanted to add badges for information that customers commonly interact with - it is usually the CLI version.
Issue #, if available:
Description of changes:
Updated README to better explain what SAM is, how to get started with SAM, provide quick links to documentation, and also help contributors get started.
For rendered content, see https://github.com/sanathkr/serverless-application-model/blob/readme_improvements/README.md
Description of how you validated changes:
Checklist:
make pr
passesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.