Skip to content

Commit 7409010

Browse files
committed
doc improvement
1 parent a18cde2 commit 7409010

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

src/site/markdown/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ operations that act on them as defined as methods (such as `GHUser.follow()`), a
77
are used in favor of using string handle (such as `GHUser.isMemberOf(GHOrganization)` instead of
88
`GHUser.isMemberOf(String)`)
99

10+
The library supports both github.com and GitHub Enterprise.
11+
1012
There are some corners of the GitHub API that's not yet implemented, but
1113
the library is implemented with the right abstractions and libraries to make it very easy to improve the coverage.
1214

@@ -34,3 +36,10 @@ Alternatively, you can have just the OAuth token in this file:
3436

3537
oauth=4d98173f7c075527cb64878561d1fe70
3638

39+
OkHttp
40+
----
41+
This library comes with a pluggable connector to use different HTTP client implementations
42+
through `HttpConnector`. In particular, this means you can use [OkHttp](http://square.github.io/okhttp/),
43+
so we can make use of it's HTTP response cache.
44+
Making a conditional request against the GitHub API and receiving a 304 response
45+
[does not count against the rate limit](http://developer.github.com/v3/#conditional-requests).

0 commit comments

Comments
 (0)