README.rdoc in fcoury-octopi-0.0.7 vs README.rdoc in fcoury-octopi-0.0.8
- old
+ new
@@ -1,9 +1,13 @@
= octopi
-Octopi is a Ruby interface to GitHub API v2 (http://develop.github.com). It's under early but active development and already works.
+Octopi is a Ruby interface to GitHub API v2 (http://develop.github.com).
+To install it as a Gem, just run:
+
+ $ sudo gem install fcoury-octopi --source http://gems.github.com
+
== Authenticated Usage
=== Seamless authentication using .gitconfig defaults
If you have your <tt>~/.gitconfig</tt> file in place, and you have a [github] section (if you don't, take a look at this GitHub Guides entry: http://github.com/guides/tell-git-your-user-name-and-email-address), you can use seamless authentication using this method:
@@ -43,18 +47,18 @@
# false - no tracing, same as if the param is ommited
# true - will output each POST or GET operation to the stdout
# curl - same as true, but in addition will output the curl equivalent of each command (for debugging)
trace: curl
-This changes the way you connect to:
+And change the way you connect to:
authenticated_with :config => "github.yml" do |g|
(...)
end
== Anonymous Usage
-This reflects the usage of the API to retrieve information, on a read-only mode where the user doesn't have to be authenticated.
+This reflects the usage of the API to retrieve information on a read-only fashion, where the user doesn't have to be authenticated.
=== Users API
Getting user information