Skip to content
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

docs: fixes and updates for README.md #831

Merged
merged 2 commits into from
Mar 9, 2020
Merged

docs: fixes and updates for README.md #831

merged 2 commits into from
Mar 9, 2020

Conversation

bcressey
Copy link
Contributor

@bcressey bcressey commented Mar 7, 2020

Issue number:
N/A

Description of changes:
Fixes a couple typos and broken links in README.md. Updates the security section to refer to the new docs.

Testing done:
Rendered via GitHub API.

Terms of contribution:

By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.

Signed-off-by: Ben Cressey <bcressey@amazon.com>
@bcressey bcressey requested review from tjkirch and iliana March 7, 2020 19:13
README.md Show resolved Hide resolved
Copy link
Contributor

@tjkirch tjkirch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Modulo the ordering nit. Thanks!

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@tjkirch tjkirch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I think it reads better with the description of each doc directly after the link, rather than in a new paragraph, so they're not disjoint.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Signed-off-by: Ben Cressey <bcressey@amazon.com>
@bcressey bcressey merged commit d21cc96 into develop Mar 9, 2020
@bcressey bcressey deleted the readme-fixes branch March 9, 2020 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants