Skip to content

Commit

Permalink
Don't wrap text in anchors [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
sferik committed Nov 23, 2011
1 parent 3dff2ab commit 0448b10
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 18 deletions.
23 changes: 11 additions & 12 deletions README.md
@@ -1,18 +1,16 @@
# Octokit
Simple Ruby wrapper for the GitHub v2 API.

![The Puppeteer](https://github.com/pengwynn/octokit/raw/master/puppeteer.jpg "The Puppeteer") by [![Cameron McEfee)](https://secure.gravatar.com/avatar/a79ff2bb7da84e275361857d2feb2b1b?s=20 "Cameron McEfee")](https://github.com/cameronmcefee)

## <a name="installation">Installation</a>
## <a name="installation"></a>Installation
gem install octokit

## <a name="ci">Continuous Integration</a>
## <a name="ci"></a>Continuous Integration
[![Build Status](https://secure.travis-ci.org/pengwynn/octokit.png)](http://travis-ci.org/pengwynn/octokit)

## <a name="documentation">Documentation</a>
## <a name="documentation"></a>Documentation
http://rdoc.info/gems/octokit

## <a name="examples">Examples</a>
## <a name="examples"></a>Examples
### Show a user
Octokit.user("sferik")
=> <#Hashie::Rash blog="http://twitter.com/sferik" company="Code for America" created_at="2008/05/14 13:36:12 -0700" email="sferik@gmail.com" followers_count=177 following_count=83 gravatar_id="1f74b13f1e5c6c69cb5d7fbaabb1e2cb" id=10308 location="San Francisco" login="sferik" name="Erik Michaels-Ober" permission=nil public_gist_count=16 public_repo_count=30 type="User">
Expand All @@ -32,7 +30,7 @@ For convenience, methods that require a repoistory argument may be passed in any
Octokit.repo("pengwynn/octokit")
=> <#Hashie::Rash created_at="2009/12/10 13:41:49 -0800" description="Simple Ruby wrapper for the GitHub v2 API and feeds" fork=false forks=25 has_downloads=true has_issues=true has_wiki=true homepage="http://wynnnetherland.com/projects/octokit" integrate_branch="master" language="Ruby" name="octokit" open_issues=8 owner="pengwynn" private=false pushed_at="2011/05/05 10:48:57 -0700" size=1804 url="https://github.com/pengwynn/octokit" watchers=92>

## <a name="authenticated_requests">Authenticated requests</a>
## <a name="authenticated_requests"></a>Authenticated Requests
For methods that require authentication, you'll need to setup a client with
your login and password.

Expand All @@ -46,7 +44,7 @@ page](https://github.com/account).
client = Octokit::Client.new(:login => "me", :oauth_token => "oauth2token")
client.follow!("sferik")

## <a name="pulls">Submitting a Pull Request</a>
## <a name="pulls"></a>Submitting a Pull Request
1. Fork the project.
2. Create a topic branch.
3. Implement your feature or bug fix.
Expand All @@ -57,7 +55,7 @@ page](https://github.com/account).
8. Commit and push your changes.
9. Submit a pull request. Please do not include changes to the version or gemspec. (If you want to create your own version for some reason, please do so in a separate commit.)

## <a name="rubies">Supported Rubies</a>
## <a name="versions"></a>Supported Ruby Versions
This library aims to support and is [tested
against](http://travis-ci.org/pengwynn/octokit) the following Ruby
implementations:
Expand All @@ -83,9 +81,10 @@ implementation, you will be personally responsible for providing patches in a
timely fashion. If critical issues for a particular implementation exist at the
time of a major release, support for that Ruby version may be dropped.

## <a name="inspiration">Inspiration</a>
Octokit was inspired by [Octopi](https://github.com/fcoury/octopi) and aims to be a lightweight, less-ActiveResourcey alternative.
## <a name="inspiration"></a>Inspiration
Octokit was inspired by [Octopi](https://github.com/fcoury/octopi) and aims to
be a lightweight, less-ActiveResourcey alternative.

## <a name="copyright">Copyright</a>
## <a name="copyright"></a>Copyright
Copyright (c) 2011 [Wynn Netherland](http://wynnnetherland.com), [Adam Stacoviak](http://adamstacoviak.com/), [Erik Michaels-Ober](https://github.com/sferik).
See [LICENSE](https://github.com/pengwynn/octokit/blob/master/LICENSE) for details.
10 changes: 5 additions & 5 deletions lib/octokit/client/labels.rb
Expand Up @@ -38,7 +38,7 @@ def add_label(repo, label, color="ffffff", options={})
post("repos/#{Repository.new(repo)}/labels", options.merge({:name => label, :color => color}), 3)
end

# Update a label
# Update a label
#
# @param repo [String, Repository, Hash] A GitHub repository
# @param label [String] The name of the label which will be updated
Expand All @@ -53,7 +53,7 @@ def update_label(repo, label, options={})
post("repos/#{Repository.new(repo)}/labels/#{URI.encode_www_form_component(label)}", options, 3)
end

# Delete a label from a repository.
# Delete a label from a repository.
#
# This deletes the label from the repository, and removes it from all issues.
#
Expand Down Expand Up @@ -140,12 +140,12 @@ def replace_all_labels(repo, number, labels, options={})
#
# @param repo [String, Repository, Hash] A GitHub repository
# @param number [String] Number ID of the milestone
# @return [Array] A list of the labels across the milestone
# @return [Array] A list of the labels across the milestone
# @see http://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone
# @example List all labels for milestone #2 on pengwynn/octokit
# Octokit.labels_for_milestone("pengwynn/octokit", 2)
def labels_for_milestone(repo, number, options={})
get("repos/#{Repository.new(repo)}/milestones/#{number}/labels", options, 3)
def labels_for_milestone(repo, number, options={})
get("repos/#{Repository.new(repo)}/milestones/#{number}/labels", options, 3)
end

end
Expand Down
2 changes: 1 addition & 1 deletion lib/octokit/client/repositories.rb
Expand Up @@ -150,7 +150,7 @@ def branches(repo, options={})
# @see http://developer.github.com/v3/issues/events/#list-events-for-a-repository
# @example Get all Issue Events for Octokit
# Octokit.repository_issue_events("pengwynn/octokit")
def repository_issue_events(repo, options={})
def repository_issue_events(repo, options={})
get "/repos/#{Repository.new repo}/issues/events", options, 3
end
alias :repo_issue_events :repository_issue_events
Expand Down
Binary file removed puppeteer.jpg
Binary file not shown.

0 comments on commit 0448b10

Please sign in to comment.