Skip to content

Commit cf0a6d4

Browse files
added documentation
1 parent 9ee0672 commit cf0a6d4

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

doc/rate_limits.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## Rate Limit API
2+
[Back to the navigation](README.md)
3+
4+
Get Rate Limit
5+
Wraps [GitHub Rate Limit API](http://developer.github.com/v3/rate_limit/).
6+
7+
#### Get All Rate Limits.
8+
9+
```php
10+
$rateLimits = $github->api('rate_limit')->getRateLimits();
11+
```
12+
13+
#### Get Core Rate Limit
14+
15+
```php
16+
$coreLimit = $github->api('rate_limit')->getCoreLimit();
17+
```
18+
19+
#### Get Search Rate Limit
20+
21+
```php
22+
$searchLimit = $github->api('rate_limit)->getSearchLimit');
23+
```

0 commit comments

Comments
 (0)