From 06a97dca32e5858192ddd123f313a0211325de2b Mon Sep 17 00:00:00 2001 From: Brandon Rosage Date: Mon, 25 Mar 2019 11:50:03 -0500 Subject: [PATCH] revised language about API authentication --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6509e34..ea5aa4e 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ Configuration file: /octocat/personal-website/_config.yml Source: /octocat/personal-website Destination: /octocat/_site Incremental build: disabled. Enable with --incremental - Generating... + Generating... GitHub Metadata: No GitHub API authentication could be found. Some fields may be missing or have incorrect data. done in 14.729 seconds. Auto-regeneration: enabled for '/octocat/personal-website' @@ -59,9 +59,7 @@ Configuration file: /octocat/personal-website/_config.yml Server running... press ctrl-c to stop. ``` -Don't worry about the GitHub API errors. They are caused because it's run in a dev enviornment and not on GitHub Pages. - -You can set a GitHub API Token by setting the `JEKYLL_GITHUB_TOKEN` to your personal access token. +Don't worry about the "No GitHub API authentication could be found" message. [API authentication is only necessary](https://github.com/jekyll/github-metadata/blob/master/docs/authentication.md) if you intend to display more detailed metadata, like a branch name. 6. Now browse to [http://localhost:4000](http://localhost:4000)