Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme.md #11

Open
wants to merge 1 commit into
base: mixin
Choose a base branch
from
Open

Update readme.md #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Because this is an extension of octokit/rest.js, it is used in a way that is ide
The goal of this mixin is to make it feel like it's naturally a part of octokit/rest.js. Because of that, it also takes input similarly to how octokit/rest.js: a set of parameters that define the desired organiation/repo and additional parameters to further define what you want the data set to represent. In the future, there will be detailed documentation on how to use the mixin.

### Output
Each of the endpoints will return an arraay of contributor objects that mimic the structure of the "List Repository Contributors" [endpoint](https://developer.github.com/v3/repos/#list-repository-contributors) of the GitHub API:
Each of the endpoints will return an array of contributor objects that mimic the structure of the "List Repository Contributors" [endpoint](https://developer.github.com/v3/repos/#list-repository-contributors) of the GitHub API:
```javascript
{
login: 'KianBadie',
Expand Down