Merge pull request #47 from jarrodldavis/bugfix/readme-nits

Fix README nits and add "Email privacy" section

README.md

@@ -1,20 +1,20 @@
 <p align="center">
-  <img alt="Probot GPG Logo" src="docs/logo-key.png" />
+  <img alt="Probot GPG logo" src="docs/logo-key.png" height="256" width="256" />
 </p>
 
 <h1 align="center">Probot GPG</h1>
 
 <p align="center">
-  <img src="docs/probot-head.png" height="50" width="50" />
+  <img alt="Probot Head logo" src="docs/probot-head.png" height="50" width="50" />
 </p>
 
-> A GitHub App built with [probot](https://github.com/probot/probot) that enforces GPG signatures on Pull Requests
+> A GitHub App built with [Probot](https://github.com/probot/probot) that enforces GPG signatures on pull requests
 
-[![Build Status](https://travis-ci.org/jarrodldavis/probot-gpg.svg?branch=develop)](https://travis-ci.org/jarrodldavis/probot-gpg)
-[![Coverage Status](https://coveralls.io/repos/github/jarrodldavis/probot-gpg/badge.svg)](https://coveralls.io/github/jarrodldavis/probot-gpg)
-[![NSP Status](https://nodesecurity.io/orgs/jarrodldavis/projects/d841ad74-0b11-47f3-9216-bc6e48414bac/badge)](https://nodesecurity.io/orgs/jarrodldavis/projects/d841ad74-0b11-47f3-9216-bc6e48414bac)
-[![Greenkeeper Status](https://badges.greenkeeper.io/jarrodldavis/probot-gpg.svg)](https://greenkeeper.io/)
-[![npm](https://img.shields.io/npm/v/@jarrodldavis/probot-gpg.svg)](https://www.npmjs.com/package/@jarrodldavis/probot-gpg)
+[![Build status](https://travis-ci.org/jarrodldavis/probot-gpg.svg?branch=develop)](https://travis-ci.org/jarrodldavis/probot-gpg "Build status")
+[![Coverage status](https://coveralls.io/repos/github/jarrodldavis/probot-gpg/badge.svg)](https://coveralls.io/github/jarrodldavis/probot-gpg "Coverage status")
+[![NSP status](https://nodesecurity.io/orgs/jarrodldavis/projects/d841ad74-0b11-47f3-9216-bc6e48414bac/badge)](https://nodesecurity.io/orgs/jarrodldavis/projects/d841ad74-0b11-47f3-9216-bc6e48414bac "NSP status")
+[![Greenkeeper status](https://badges.greenkeeper.io/jarrodldavis/probot-gpg.svg)](https://greenkeeper.io/ "Greenkeeper status")
+[![npm](https://img.shields.io/npm/v/@jarrodldavis/probot-gpg.svg)](https://www.npmjs.com/package/@jarrodldavis/probot-gpg "npm")
 
 ## Setup
 
@@ -32,23 +32,26 @@ npm start
 
 See [docs/deploy.md](docs/deploy.md) if you would like to run your own instance of this plugin.
 
-
 ## How it works
 
 Git supports [signing commits with GPG keys](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work) to verify commit authorship beyond the easy-to-forge [author](https://git-scm.com/docs/git-commit#git-commit---authorltauthorgt) field.
 
-GitHub supports [verifying GPG signatures on commits](https://github.com/blog/2144-gpg-signature-verification) and has an excellent [series of help articles](https://help.github.com/articles/signing-commits-with-gpg/) for creating a GPG key, using it with `git` locally, and linking it to your GitHub account.
+GitHub supports [verifying GPG signatures on commits](https://github.com/blog/2144-gpg-signature-verification) and has an excellent [series of help articles](https://help.github.com/articles/signing-commits-with-gpg/) for creating a GPG key, using it with `git` locally, and linking it to a GitHub account.
 
-After installation, this app [checks all commits](https://developer.github.com/v3/repos/commits/#compare-two-commits) of new (or newly updated) pull requests for valid GPG signatures [according to the GitHub API](https://developer.github.com/changes/2016-04-04-git-signing-api-preview/). Note that for the status check to pass, _every_ contributor of a pull request must:
+After installation, this app [checks all commits](https://developer.github.com/v3/repos/commits/#compare-two-commits) of new (or newly updated) pull requests for valid GPG signatures [according to the GitHub API](https://developer.github.com/changes/2016-04-04-git-signing-api-preview/). Note that for the status check to be `success`, _every_ contributor of a pull request must:
 - set up a GPG key on their local machine
 - sign _all_ of their commits in the pull request with that key
 - link that key with their GitHub account
 
-![GPG Status Check Success](docs/screenshot-success.png "GPG Status Check Success")
+![GPG status check success screenshot](docs/screenshot-success.png "GPG status check success screenshot")
+
+Otherwise, the app will set the status to `failure`.
+
+![GPG status check failed screenshot](docs/screenshot-failure.png "GPG status check failed screenshot")
 
-Otherwise, the app will set the status to `failed`.
+## Email privacy
 
-![GPG Status Check Failed](docs/screenshot-failure.png "GPG Status Check Failed")
+If you or any of your contributors use a [GitHub-provided `noreply` email address](https://help.github.com/articles/about-commit-email-addresses/) to keep a personal email address private, that `noreply` address should be used when creating a GPG key. Make sure that [`git`'s config is also using that `noreply` address](https://help.github.com/articles/setting-your-commit-email-address-in-git/) so that GitHub associates the GPG key correctly and validates it.
 
 ## Further reading
 
@@ -60,7 +63,7 @@ Otherwise, the app will set the status to `failed`.
 - [The GNU Privacy Guard](https://gnupg.org)
 - [Setting up Git commit signing on macOS](https://gist.github.com/bmhatfield/cc21ec0a3a2df963bffa3c1f884b676b)
 
-## Special Thanks and Attributions
+## Special thanks and attributions
 
 - [@JasonEtco](https://github.com/jasonetco) for the lovingly crafted logo
-- [@probot](https://github.com/probot) for the Probot head, which was found on [wikimedia.org](https://commons.wikimedia.org/wiki/File:Robot-clip-art-book-covers-feJCV3-clipart.png) and is from clipartkid.com, licensed [CC BY-SA-4.0](https://creativecommons.org/licenses/by-sa/4.0/deed.en)
+- [@probot](https://github.com/probot) for the Probot head, which was found on [wikimedia.org](https://commons.wikimedia.org/wiki/File:Robot-clip-art-book-covers-feJCV3-clipart.png) and is from clipartkid.com, licensed [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/deed.en)

docs/deploy.md

@@ -1,6 +1,6 @@
 # Deploying
 
-If you would like to run your own instance of this plugin, see the [docs for deploying plugins](https://github.com/probot/probot/blob/master/docs/deployment.md).
+If you would like to run your own instance of this plugin, see [Probot's docs for deploying plugins](https://github.com/probot/probot/blob/master/docs/deployment.md).
 
 This plugin requires these **Permissions & events** for the GitHub App: