Skip to content
/ github Public
forked from noansknv/github

A higher-level wrapper around the Github API. Intended for the browser.

License

Notifications You must be signed in to change notification settings

dbraga/github

Repository files navigation

Github.js

Downloads per month Latest version Gitter Travis Codecov

Github.js provides a minimal higher-level wrapper around Github's API. It was concieved in the context of Prose, a content editor for GitHub.

Installation

Github.js is available from npm or (soon) cdnjs.

npm install github-api

## Compatibility

Sauce Test Status

Note: Starting from version 0.10.8, Github.js supports Internet Explorer 9. However, the underlying methodology used under the hood to perform CORS requests (the XDomainRequest object), has limitations. In particular, requests must be targeted to the same scheme as the hosting page. This means that if a page is at http://example.com, your target URL must also begin with HTTP. Similarly, if your page is at https://example.com, then your target URL must also begin with HTTPS. For this reason, if your requests are sent to the GitHub API (the default), which are served via HTTPS, your page must use HTTPS too.

GitHub Tools

The team behind Github.js has created a whole organization, called GitHub Tools, dedicated to GitHub and its API. In the near future this repository could be moved under the GitHub Tools organization as well. In the meantime, we recommend you to take a look at other projects of the organization.

Example

TODO

About

A higher-level wrapper around the Github API. Intended for the browser.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 99.1%
  • Other 0.9%