Skip to content

Commit bfa0fb2

Browse files
committed
Update doc references.
1 parent 6772eab commit bfa0fb2

File tree

1 file changed

+39
-39
lines changed

1 file changed

+39
-39
lines changed

README.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
<div align="center">
2-
<a href="http://peter-murach.github.io/github/"><img width="136" src="https://github.com/peter-murach/github/raw/master/icons/github_api.png" alt="github api logo" /></a>
2+
<a href="http://piotrmurach.github.io/github/"><img width="136" src="https://github.com/piotrmurach/github/raw/master/icons/github_api.png" alt="github api logo" /></a>
33
</div>
44
# GithubAPI
55
[![Gem Version](https://badge.fury.io/rb/github_api.svg)][gem]
6-
[![Build Status](https://secure.travis-ci.org/peter-murach/github.svg?branch=master)][travis]
7-
[![Code Climate](https://codeclimate.com/github/peter-murach/github/badges/gpa.svg)][codeclimate]
8-
[![Coverage Status](https://coveralls.io/repos/peter-murach/github/badge.svg?branch=master)][coverage]
9-
[![Inline docs](http://inch-ci.org/github/peter-murach/github.svg)][inchpages]
10-
[![Dependency Status](https://gemnasium.com/peter-murach/github.svg?travis)][gemnasium]
6+
[![Build Status](https://secure.travis-ci.org/piotrmurach/github.svg?branch=master)][travis]
7+
[![Code Climate](https://codeclimate.com/github/piotrmurach/github/badges/gpa.svg)][codeclimate]
8+
[![Coverage Status](https://coveralls.io/repos/piotrmurach/github/badge.svg?branch=master)][coverage]
9+
[![Inline docs](http://inch-ci.org/github/piotrmurach/github.svg)][inchpages]
10+
[![Dependency Status](https://gemnasium.com/piotrmurach/github.svg?travis)][gemnasium]
1111

1212
[gem]: http://badge.fury.io/rb/github_api
13-
[travis]: http://travis-ci.org/peter-murach/github
14-
[codeclimate]: https://codeclimate.com/github/peter-murach/github
15-
[coverage]: https://coveralls.io/r/peter-murach/github
16-
[inchpages]: http://inch-ci.org/github/peter-murach/github
17-
[gemnasium]: https://gemnasium.com/peter-murach/github
13+
[travis]: http://travis-ci.org/piotrmurach/github
14+
[codeclimate]: https://codeclimate.com/github/piotrmurach/github
15+
[coverage]: https://coveralls.io/r/piotrmurach/github
16+
[inchpages]: http://inch-ci.org/github/piotrmurach/github
17+
[gemnasium]: https://gemnasium.com/piotrmurach/github
1818

19-
[Website](http://peter-murach.github.io/github/) | [Wiki](https://github.com/peter-murach/github/wiki) | [RDocs](http://rubydoc.info/github/peter-murach/github/master/frames)
19+
[Website](http://piotrmurach.github.io/github/) | [Wiki](https://github.com/piotrmurach/github/wiki) | [RDocs](http://rubydoc.info/github/piotrmurach/github/master/frames)
2020

2121
A Ruby client for the official GitHub API.
2222

@@ -87,7 +87,7 @@ gem "github_api"
8787
To start using the gem, you can either perform requests directly on `Github` namespace:
8888

8989
```ruby
90-
Github.repos.list user: 'peter-murach'
90+
Github.repos.list user: 'piotrmurach'
9191
```
9292

9393
or create a new client instance like so
@@ -99,7 +99,7 @@ github = Github.new
9999
and then call api methods, for instance, to list a given user repositories do
100100

101101
```ruby
102-
github.repos.list user: 'peter-murach'
102+
github.repos.list user: 'piotrmurach'
103103
```
104104

105105
### 1.1 API Navigation
@@ -108,24 +108,24 @@ The **github_api** closely mirrors the [GitHub API](https://developer.github.com
108108

109109
```ruby
110110
github = Github.new
111-
github.repos.contents.create 'peter-murach', 'finite_machine', 'hello.rb',
111+
github.repos.contents.create 'piotrmurach', 'finite_machine', 'hello.rb',
112112
path: 'hello.rb',
113113
content: "puts 'hello ruby'"
114114
```
115115

116116
The whole library reflects the same api navigation. Therefore, if you need to list releases for a repository do:
117117

118118
```ruby
119-
github.repos.releases.list 'peter-murach', 'finite_machine'
119+
github.repos.releases.list 'piotrmurach', 'finite_machine'
120120
```
121121

122122
or to list a user's followers:
123123

124124
```ruby
125-
github.users.followers.list 'peter-murach'
125+
github.users.followers.list 'piotrmurach'
126126
```
127127

128-
The code base has been extensively documented with examples of how to use each method. Please refer to the [documentation](http://rubydoc.info/github/peter-murach/github/master/frames) under the `Github::Client` class name.
128+
The code base has been extensively documented with examples of how to use each method. Please refer to the [documentation](http://rubydoc.info/github/piotrmurach/github/master/frames) under the `Github::Client` class name.
129129

130130
Alternatively, you can find out which methods are supported by an api by calling `actions` on a class or instance. For example, in order to find out available endpoints for `Github::Client::Repos::Contents` api call `actions` method:
131131

@@ -140,10 +140,10 @@ The code base is modular. This means that you can work specifically with a given
140140

141141
```ruby
142142
starring = Github::Client::Activity::Starring.new oauth_token: token
143-
starring.star 'peter-murach', 'github'
143+
starring.star 'piotrmurach', 'github'
144144
```
145145

146-
Please refer to the [documentation](http://rubydoc.info/github/peter-murach/github/master/frames) and look under `Github::Client` to see all available classes.
146+
Please refer to the [documentation](http://rubydoc.info/github/piotrmurach/github/master/frames) and look under `Github::Client` to see all available classes.
147147

148148
### 1.3 Arguments
149149

@@ -153,34 +153,34 @@ Arguments can be passed directly inside the method called. The `required` argume
153153

154154
```ruby
155155
issues = Github::Client::Issues.new
156-
issues.milestones.list 'peter-murach', 'github', state: 'open'
156+
issues.milestones.list 'piotrmurach', 'github', state: 'open'
157157
```
158158

159159
In the previous example, the order of arguments is important. However, each method also allows you to specify `required` arguments using hash symbols and thus remove the need for ordering. Therefore, the same example could be rewritten like so:
160160

161161
```ruby
162162
issues = Github::Client::Issues.new
163-
issues.milestones.list user: 'peter-murach', repo: 'github', state: 'open'
163+
issues.milestones.list user: 'piotrmurach', repo: 'github', state: 'open'
164164
```
165165

166166
Furthermore, `required` arguments can be passed during instance creation:
167167

168168
```ruby
169-
issues = Github::Client::Issues.new user: 'peter-murach', repo: 'github'
169+
issues = Github::Client::Issues.new user: 'piotrmurach', repo: 'github'
170170
issues.milestones.list state: 'open'
171171
```
172172

173173
Similarly, the `required` arguments for the request can be passed inside the current scope such as:
174174

175175
```ruby
176176
issues = Github::Client::Issues.new
177-
issues.milestones(user: 'peter-murach', repo: 'github').list state: 'open'
177+
issues.milestones(user: 'piotrmurach', repo: 'github').list state: 'open'
178178
```
179179

180180
But why limit ourselves? You can mix and match arguments, for example:
181181

182182
```ruby
183-
issues = Github::Client::Issues.new user: 'peter-murach'
183+
issues = Github::Client::Issues.new user: 'piotrmurach'
184184
issues.milestones(repo: 'github').list
185185
issues.milestones(repo: 'tty').list
186186
```
@@ -189,18 +189,18 @@ You can also use a bit of syntactic sugar whereby "username/repository" can be p
189189

190190
```ruby
191191
issues = Github::Client::Issues.new
192-
issues.milestones('peter-murach/github').list
193-
issues.milestones.list 'peter-murach/github'
192+
issues.milestones('piotrmurach/github').list
193+
issues.milestones.list 'piotrmurach/github'
194194
```
195195

196196
Finally, use the `with` scope to clearly denote your requests
197197

198198
```ruby
199199
issues = Github::Client::Issues.new
200-
issues.milestones.with(user: 'peter-murach', repo: 'github').list
200+
issues.milestones.with(user: 'piotrmurach', repo: 'github').list
201201
```
202202

203-
Please consult the method [documentation](http://rubydoc.info/github/peter-murach/github/master/frames) or [GitHub specification](https://developer.github.com/v3/) to see which arguments are required and what are the option parameters.
203+
Please consult the method [documentation](http://rubydoc.info/github/piotrmurach/github/master/frames) or [GitHub specification](https://developer.github.com/v3/) to see which arguments are required and what are the option parameters.
204204

205205
### 1.4 Response Querying
206206

@@ -210,7 +210,7 @@ For example, when request is issued to list all the branches on a given reposito
210210

211211
```ruby
212212
repos = Github::Client::Repos.new
213-
repos.branches user: 'peter-murach', repo: 'github' do |branch|
213+
repos.branches user: 'piotrmurach', repo: 'github' do |branch|
214214
puts branch.name
215215
end
216216
```
@@ -220,7 +220,7 @@ end
220220
The `ResponseWrapper` allows you to call json attributes directly as method calls. there is no magic here, all calls are delegated to the response body. Therefore, you can directly inspect request body by calling `body` method on the `ResponseWrapper` like so:
221221

222222
```ruby
223-
response = repos.branches user: 'peter-murach', repo: 'github'
223+
response = repos.branches user: 'piotrmurach', repo: 'github'
224224
response.body # => Array of branches
225225
```
226226

@@ -229,7 +229,7 @@ response.body # => Array of branches
229229
Each response comes packaged with methods allowing for inspection of HTTP start line and headers. For example, to check for rate limits and status codes do:
230230

231231
```ruby
232-
response = Github::Client::Repos.branches 'peter-murach', 'github'
232+
response = Github::Client::Repos.branches 'piotrmurach', 'github'
233233
response.headers.ratelimit_limit # "5000"
234234
response.headers.ratelimit_remaining # "4999"
235235
response.headers.status # "200"
@@ -243,7 +243,7 @@ response.headers.cache_control # "public, max-age=60, s-maxage=60"
243243
If you want to verify if the response was success, namely, that the `200` code was returned call the `success?` like so:
244244

245245
```ruby
246-
response = Github::Client::Repos.branches 'peter-murach', 'github'
246+
response = Github::Client::Repos.branches 'piotrmurach', 'github'
247247
response.success? # => true
248248
```
249249

@@ -267,7 +267,7 @@ In order to set custom media types for a request use the accept header. By using
267267

268268
```ruby
269269
issues = Github::Client::Issues.new
270-
issues.get 'peter-murach', 'github', 108, accept: 'application/vnd.github.raw'
270+
issues.get 'piotrmurach', 'github', 108, accept: 'application/vnd.github.raw'
271271
```
272272

273273
## 2 Configuration
@@ -282,7 +282,7 @@ The configuration options can be set by using the `configure` helper
282282
Github.configure do |c|
283283
c.basic_auth = "login:password"
284284
c.adapter = :typheous
285-
c.user = 'peter-murach'
285+
c.user = 'piotrmurach'
286286
c.repo = 'finite_machine'
287287
end
288288
```
@@ -302,7 +302,7 @@ or simply by passing hash of options to an instance like so
302302
```ruby
303303
github = Github.new basic_auth: 'login:password',
304304
adapter: :typheous,
305-
user: 'peter-murach',
305+
user: 'piotrmurach',
306306
repo: 'finite_machine'
307307
```
308308

@@ -452,7 +452,7 @@ To list the scopes that the particular GitHub API action checks for do:
452452

453453
```ruby
454454
repos = Github::Client::Repos.new
455-
response = repos.list user: 'peter-murach'
455+
response = repos.list user: 'piotrmurach'
456456
response.headers.accepted_oauth_scopes # => ['delete_repo', 'repo', 'public_repo']
457457
```
458458

@@ -679,8 +679,8 @@ The `mock` tests are in the `spec` directory and their primary concern is to tes
679679

680680
## Development
681681

682-
Questions or problems? Please post them on the [issue tracker](https://github.com/peter-murach/github/issues). You can contribute changes by forking the project and submitting a pull request. You can ensure the tests are passing by running `bundle` and `rake`.
682+
Questions or problems? Please post them on the [issue tracker](https://github.com/piotrmurach/github/issues). You can contribute changes by forking the project and submitting a pull request. You can ensure the tests are passing by running `bundle` and `rake`.
683683

684684
## Copyright
685685

686-
Copyright (c) 2011-2014 Piotr Murach. See LICENSE.txt for further details.
686+
Copyright (c) 2011-2016 Piotr Murach. See LICENSE.txt for further details.

0 commit comments

Comments
 (0)