From 66c5eb3174376098463348889bca431578fcb303 Mon Sep 17 00:00:00 2001
From: Ben <9087625+benfdking@users.noreply.github.com>
Date: Tue, 5 Mar 2019 14:09:30 +0000
Subject: [PATCH] Small clarification around health checks (#84)

Type: docs
I simply added the word health check. I was searching all over the
package for a health check, to only realise that it had been called
ping. I think the small addition might help others avoid my troubles.
---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6accae3..f833b37 100644
--- a/README.md
+++ b/README.md
@@ -361,7 +361,7 @@ The command line to run `oauth2_proxy` in this configuration would look like thi
 OAuth2 Proxy responds directly to the following endpoints. All other endpoints will be proxied upstream when authenticated. The `/oauth2` prefix can be changed with the `--proxy-prefix` config variable.
 
 - /robots.txt - returns a 200 OK response that disallows all User-agents from all paths; see [robotstxt.org](http://www.robotstxt.org/) for more info
-- /ping - returns an 200 OK response
+- /ping - returns a 200 OK response, which is intended for use with health checks  
 - /oauth2/sign_in - the login page, which also doubles as a sign out page (it clears cookies)
 - /oauth2/start - a URL that will redirect to start the OAuth cycle
 - /oauth2/callback - the URL used at the end of the OAuth cycle. The oauth app will be configured with this as the callback url.