Permalink
Browse files

Updated readme with new info.

  • Loading branch information...
1 parent 191ea3d commit e0e49c9a4a467e8eefb83ee7673ae0da84947728 @Raynes committed Dec 9, 2011
Showing with 6 additions and 2 deletions.
  1. +6 −2 README.md
View
@@ -6,7 +6,7 @@ This library is the successor to my old [clj-github](https://github.com/Raynes/c
## Usage
-This is on clojars, of course. Just add `[tentacles "0.1.1"]` to your `:dependencies` in your project.clj file.
+This is on clojars, of course. Just add `[tentacles "0.1.3"]` to your `:dependencies` in your project.clj file.
### CODE!
@@ -37,7 +37,11 @@ user> (repos/repos {:auth "Raynes:REDACTED" :per-page 1})
If an API function has no options and authentication would have no uses for that particular call, the options map is not a parameter at all. For API calls that can do different things based on whether or not you are authenticated but authentication is not **required**, then the options map will be an optional argument. For API calls that require authentication to function at all, the options map is a required argument. Any data that is required by an API call is a positional argument to the API functions. The options map only ever contains authentication info and/or optional input.
-The Github API is massive and great. I can't demonstrate every API call. Everything is generally just as easy as the above examples, and I'm working hard to document things as well as possible, so go explore! There are even some [Marginalia docs](http://raynes.github.com/tentacles)!
+Authentication information can be basic auth info (username:password) as demonstrated above or it can be an oauth2 access token. In that case, you'd pass the `:oauth-token` key instead.
+
+The Github API is massive and great. I can't demonstrate every API call. Everything is generally just as easy as the above examples, and I'm working hard to document things as well as possible, so go explore!
+
+Here are some lovely [Marginalia docs](http://raynes.github.com/tentacles). I also wrote a demonstrational [blog post](http://blog.raynes.me/blog/2011/12/02/waving-our-tentacles/) about Tentacles that I intend to keep updated with future releases.
If you run into something that isn't documented well or you don't understand, look for the API call on the Github API [docs](http://developer.github.com/v3/). If you feel like it, please submit a pull request with improved documentation. Let's make this the most impressive Github API library around!

0 comments on commit e0e49c9

Please sign in to comment.