Skip to content

Commit

Permalink
Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
fcoury committed Apr 23, 2009
1 parent 3344a5a commit 3a2d979
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.rdoc
@@ -1,6 +1,10 @@
= 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

Expand Down Expand Up @@ -45,15 +49,15 @@ Use the following format:
# 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

Expand Down

0 comments on commit 3a2d979

Please sign in to comment.