From 07c0df07de9a00b717d664bfbd51846438aef382 Mon Sep 17 00:00:00 2001 From: Lloyd Dewolf Date: Tue, 28 Oct 2014 13:06:21 -0700 Subject: [PATCH] [doc] Readme: use text from hub man page for hub.protocol. - "git protocol for read and ssh for write" had introduced additional expectations of behavior. --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3856aba7..8a34c13e 100644 --- a/README.md +++ b/README.md @@ -296,9 +296,13 @@ the API and exchange it for an OAuth token, which it saves in "~/.config/hub". ### HTTPS instead of git protocol -If you prefer using the HTTPS protocol for GitHub repositories instead of the git -protocol for read and ssh for write, you can set "hub.protocol" to "https". -"hub.protocol" only applies when the "OWNER/REPO" shorthand is used instead of a full git URL. +If you prefer the HTTPS protocol for GitHub repositories, you can +set "hub.protocol" to "https". This will affect clone, fork, remote add and +other operations that expand references to GitHub repositories +that otherwise use git and ssh protocols. + +"hub.protocol" only applies when the "OWNER/REPO" shorthand is used instead of +a full git URL. ~~~ sh # default behavior