Update read me

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,7 @@
-*Issue #, if available:*
+#
 
-*Description of changes:*
+_Issue #, if available:_
 
+_Description of changes:_
 
 By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

CHANGELOG.md

@@ -2,48 +2,48 @@
 
 ## 1.3.0 - 2019-02-10
 
-* Empty provider output is now excluded
-  (https://github.com/awslabs/git-secrets/issues/34)
-* Spaces are now supported in git exec path, making more Windows
+- Empty provider output is now excluded
+  <https://github.com/awslabs/git-secrets/issues/34>
+- Spaces are now supported in git exec path, making more Windows
   paths execute properly.
-* Patterns with newlines and carriage returns are now loaded properly.
-* Patterns that contain only "\n" are now ignored.
-* Various Bash 4 fixes (https://github.com/awslabs/git-secrets/issues/66).
-* Make IAM key scanning much more targeted.
+- Patterns with newlines and carriage returns are now loaded properly.
+- Patterns that contain only "\n" are now ignored.
+- Various Bash 4 fixes <https://github.com/awslabs/git-secrets/issues/66>.
+- Make IAM key scanning much more targeted.
 
 ## 1.2.1 - 2016-06-27
 
-* Fixed an issue where secret provider commands were causing "command not
+- Fixed an issue where secret provider commands were causing "command not
   found" errors due to a previously set IFS variable.
-  https://github.com/awslabs/git-secrets/pull/30
+  <https://github.com/awslabs/git-secrets/pull/30>
 
 ## 1.2.0 - 2016-05-23
 
-* Fixed an issue where spaces files with spaces in their names were not being
+- Fixed an issue where spaces files with spaces in their names were not being
   properly scanned in the pre-commit hook.
-* Now ignoring empty lines and comments (e.g., `#`) in the .gitallowed file.
-* Fixed an issue where numbers were being compared to strings causing failures
+- Now ignoring empty lines and comments (e.g., `#`) in the .gitallowed file.
+- Fixed an issue where numbers were being compared to strings causing failures
   on some platforms.
 
 ## 1.1.0 - 2016-04-06
 
-* Bug fix: the pre-commit hook previously only scanned the working directory
+- Bug fix: the pre-commit hook previously only scanned the working directory
   rather than staged files. This release updates the pre-commit hook to instead
   scan staged files so that git-secrets will detect violations if the working
   directory drifts from the staging directory.
-* Added the `--scan-history` subcommand so that you can scan your entire
+- Added the `--scan-history` subcommand so that you can scan your entire
   git history for violations.
-* Added the ability to filter false positives by using a .gitallowed file.
-* Added support for `--cached`, `--no-index`, and `--untracked` to the `--scan`
+- Added the ability to filter false positives by using a .gitallowed file.
+- Added support for `--cached`, `--no-index`, and `--untracked` to the `--scan`
   subcommand.
 
 ## 1.0.1 - 2016-01-11
 
-* Now works correctly with filenames in a repository that contain spaces when
+- Now works correctly with filenames in a repository that contain spaces when
   executing `git secrets --scan` with no provided filename (via `git grep`).
-* Now works with git repositories with hundreds of thousands of files when
+- Now works with git repositories with hundreds of thousands of files when
   using `git secrets --scan` with no provided filename (via `git grep`).
 
 ## 1.0.0 - 2015-12-10
 
-* Initial release of ``git-secrets``.
+- Initial release of `git-secrets`.

CODE_OF_CONDUCT.md

@@ -1,4 +1,5 @@
-## Code of Conduct
-This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). 
-For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact 
+# Code of Conduct
+
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
 opensource-codeofconduct@amazon.com with any additional questions or comments.

CONTRIBUTING.md

@@ -1,29 +1,28 @@
 # Contributing Guidelines
 
-Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional 
+Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
 documentation, we greatly value feedback and contributions from our community.
 
-Please read through this document before submitting any issues or pull requests to ensure we have all the necessary 
+Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
 information to effectively respond to your bug report or contribution.
 
-
 ## Reporting Bugs/Feature Requests
 
 We welcome you to use the GitHub issue tracker to report bugs or suggest features.
 
-When filing an issue, please check [existing open](https://github.com/awslabs/git-secrets/issues), or [recently closed](https://github.com/awslabs/git-secrets/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already 
+When filing an issue, please check [existing open](https://github.com/awslabs/git-secrets/issues), or [recently closed](https://github.com/awslabs/git-secrets/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
 reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
 
-* A reproducible test case or series of steps
-* The version of our code being used
-* Any modifications you've made relevant to the bug
-* Anything unusual about your environment or deployment
-
+- A reproducible test case or series of steps
+- The version of our code being used
+- Any modifications you've made relevant to the bug
+- Anything unusual about your environment or deployment
 
 ## Contributing via Pull Requests
+
 Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
 
-1. You are working against the latest source on the *master* branch.
+1. You are working against the latest source on the _master_ branch.
 2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
 3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
 
@@ -36,23 +35,22 @@ To send us a pull request, please:
 5. Send us a pull request, answering any default questions in the pull request interface.
 6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
 
-GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and 
+GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
 [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
 
-
 ## Finding contributions to work on
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/awslabs/git-secrets/labels/help%20wanted) issues is a great place to start. 
 
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/awslabs/git-secrets/labels/help%20wanted) issues is a great place to start.
 
 ## Code of Conduct
-This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). 
-For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact 
-opensource-codeofconduct@amazon.com with any additional questions or comments.
 
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
+opensource-codeofconduct@amazon.com with any additional questions or comments.
 
 ## Security issue notifications
-If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
 
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
 
 ## Licensing
 

NOTICE.txt → NOTICE.md

@@ -1,4 +1,5 @@
-git-secrets
+# git-secrets
+
 Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
 bats