Work on docs re: GitHub setup

Author: jennybc

R/create.R

@@ -91,9 +91,12 @@ create_project <- function(path,
 #' required in order for `create_from_github()` to do ["fork and
 #' clone"](https://help.github.com/articles/fork-a-repo/). It is also required
 #' by [use_github()], which connects existing local projects to GitHub.
+#' [use_github()] has more detailed advice on working with the `protocol` and
+#' `credentials` arguments.
 #'
-#' @seealso [use_course()] for one-time download of all files in a Git repo,
-#'   without any local or remote Git operations.
+#' @seealso [use_github()] for GitHub setup advice. [use_course()] for one-time
+#'   download of all files in a Git repo, without any local or remote Git
+#'   operations.
 #'
 #' @inheritParams create_package
 #' @param repo_spec GitHub repo specification in this form: `owner/repo`.
@@ -115,6 +118,17 @@ create_project <- function(path,
 #' @examples
 #' \dontrun{
 #' create_from_github("r-lib/usethis")
+#'
+#' create_from_github("r-lib/usethis", protocol = "https")
+#'
+#' ## various ways code can look when specifying ssh credential explicitly
+#' create_from_github("r-lib/usethis", credentials = git2r::cred_ssh_key())
+#'
+#' cred <- git2r::cred_ssh_key(
+#'   publickey = "path/to/id_rsa.pub",
+#'   privatekey = "path/to/id_rsa"
+#' )
+#' create_from_github("cran/TailRank", credentials = cred)
 #' }
 create_from_github <- function(repo_spec,
                                destdir = NULL,

R/github.R

@@ -3,7 +3,8 @@
 #' `use_github()` takes a local project, creates an associated repo on GitHub,
 #' adds it to your local repo as the `origin` remote, and makes an initial push
 #' to synchronize. `use_github()` requires that your project already be a Git
-#' repository, which you can accomplish with [use_git()], if needed.
+#' repository, which you can accomplish with [use_git()], if needed. See the
+#' Authentication section below for other necessary setup.
 #'
 #' @section Authentication:
 #' A new GitHub repo will be created via the GitHub API, therefore you must
@@ -13,8 +14,8 @@
 #' environment variable. Use [browse_github_pat()] to get help obtaining and
 #' storing your PAT. See [gh::gh_whoami()] for even more detail.
 #'
-#' The argument `protocol` reflects how you wish to authenticate with GitHub
-#' for this repo in the long run. This determines the form of the URL for the
+#' The argument `protocol` specifies the transport protocol you wish to use for
+#' this repo in the long run. This determines the form of the URL for the
 #' `origin` remote:
 #'   * `protocol = "ssh"`: `git@@github.com:<OWNER>/<REPO>.git`
 #'   * `protocol = "https"`: `https://github.com/<OWNER>/<REPO>.git`