From abddf33f46eeb623477d56dbd49f4a638026c09a Mon Sep 17 00:00:00 2001 From: Ian Ferguson Date: Fri, 10 Jun 2016 08:47:24 -0400 Subject: [PATCH] Add FAQ for resolving github api token issues --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 93e95bc..468a2cf 100644 --- a/README.md +++ b/README.md @@ -162,3 +162,25 @@ A plugin is: ### How can I list plugins as dependencies to my plugin? Create a new fishfile at the root level of your project and write the plugin URL such as *github.com/owner/repo*. + +### Why am I receiving errors when running `fisher ls-remote`? + +If you are consistently seeing the following error while repeatedly running `fisher ls-remote`: + +``` +! I could not update the remote index. + +This is most likely a problem with http://api.github.com/ +or a connection timeout. If the problem persists, open an +issue in: +``` + +You may need to set the GITHUB_USER and GITHUB_TOKEN environment variables in your shell, to prevent github's search api from +throttling/rejecting anonymous requests: + +``` +set -x GITHUB_USER your_username +set -x GITHUB_TOKEN your_github_api_token_for_fisherman +``` + +For instructions on creating an api token, [see Step 1 of this help guide from Christopher Anderson](https://gist.github.com/christopheranderton/8644743#step-1---create-a-personal-access-token-for-homebrew)