Github Wrapper

A wrapper to work with the Github Web API.

Browser Support

This library relies on Fetch API. And this API is supported in the following browsers.

| | | | | --- | --- | --- | --- | --- | 39+ ✔ | 42+ ✔ | 29+ ✔ | 10.1+ ✔ | Nope ✘ |

Dependencies

This library depends on fetch to make requests to the Github Web API. For environments that don't support fetch, you'll need to provide a polyfill to browser or polyfill to Node.

Installation

$ npm install github-wrapper --save

How to use

ES6

// to import a specific method
import { method } from 'github-wrapper';

// to import everything
import * as githubWrapper from 'github-wrapper';

CommonJS

var githubWrapper = require('github-wrapper');

UMD in Browser

<!-- to import non-minified version -->
<script src="github-wrapper.umd.js"></script>

<!-- to import minified version -->
<script src="github-wrapper.umd.min.js"></script>

After that the library will be available to the Global as githubWrapper. Follow an example:

const albums = githubWrapper.searchAlbums('Choosen Artist');

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

| David Alves |

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details