Skip to content

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

License

Notifications You must be signed in to change notification settings

subversivo58/github-api

Repository files navigation

github-api

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

Notice:

This is a free adaptation of the amazing Github.js library to support ES6 modules.

This project was based on version 3.3.0 and it is not based on a fork so there is no forecast for immediate updates from updates from the original source.

How to use:

See original Github.js repo for more information about use and documentation api.

Upload binary files:

Yes you can. The original library was slightly modified to allow for this.

You can see these changes on the following lines

A low-level wrapper was designed to allow this: see gist

Small size:

The minified bundle from the original library contains all dependencies via the compiler and this makes its size around 90.2 kB ... this adaptation that does not support legacy browsers and does not support Node is only 29.1 kB.

Even at 14 kB from the "axios" module, it is still below half the original bundle with only 43.1 kB.

Disclainer:

The original library is distributed under the BSD-3-Clause License, so this adaptation, which uses practically all the original code, is also distributed under the same license.

License:

Copyright (c) 2012 Michael Aufreiter, Development Seed All rights reserved.

Copyright (c) 2020 Lauro Moraes <https://github.com/subversivo58>

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this
  list of conditions and the following disclaimer in the documentation and/or
  other materials provided with the distribution.
- Neither the name "Development Seed" nor the names of its contributors may be
  used to endorse or promote products derived from this software without
  specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

BSD-3-Clause License from original Github.js library license. See license here

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published