6bd4969ec6 | ||
---|---|---|
.. | ||
lib | ||
node_modules/universal-user-agent | ||
plugins | ||
LICENSE | ||
README.md | ||
index.d.ts | ||
index.js | ||
package.json |
README.md
rest.js
GitHub REST API client for JavaScript
Installation
npm install @octokit/rest
Usage
const Octokit = require('@octokit/rest')
const octokit = new Octokit()
// Compare: https://developer.github.com/v3/repos/#list-organization-repositories
octokit.repos.listForOrg({
org: 'octokit',
type: 'public'
}).then(({ data }) => {
// handle data
})
See https://octokit.github.io/rest.js/ for full documentation.
Contributing
We would love you to contribute to @octokit/rest
, pull requests are very welcome! Please see CONTRIBUTING.md for more information.
Credits
@octokit/rest
was originally created as node-github
in 2012 by Mike de Boer from Cloud9 IDE, Inc.
It was adopted and renamed by GitHub in 2017