From e929dfd9eced7694f085a9227ce8ed6127467d38 Mon Sep 17 00:00:00 2001 From: Will Norris Date: Sat, 19 Apr 2014 14:42:16 -0700 Subject: [PATCH] add doc section on conditional requests --- github/doc.go | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/github/doc.go b/github/doc.go index 89c6db3..e75ca12 100644 --- a/github/doc.go +++ b/github/doc.go @@ -67,6 +67,16 @@ up-to-date rate limit data for the client. Learn more about GitHub rate limiting at http://developer.github.com/v3/#rate-limiting. +Conditional Requests + +The GitHub API has good support for conditional requests which will help +prevent you from burning through your rate limit, as well as help speed up your +application. go-github does not handle conditional requests directly, but is +instead designed to work with a caching http.Transport. We recommend using +https://github.com/gregjones/httpcache, which can be used in conjuction with +https://github.com/sourcegraph/apiproxy to provide additional flexibility and +control of caching rules. + Creating and Updating Resources All structs for GitHub resources use pointer values for all non-repeated fields.