A collection of methods to extend the functionality of Github.js (known on npm as github-api)
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo
dist
doc
src
test
.babelrc
.codeclimate.yml
.editorconfig
.gitignore
.jscsrc
.jshintrc
.travis.yml
MIT-LICENSE.txt
README.md
bower.json
esdoc.json
gulpfile.js
karma.conf.js
package.json

README.md

GitHub Extended

Code Climate Build Status Coverage Status

GitHub Extended is a collection of methods to extend the functionality of Github.js (known on npm as github-api).

Requirements

Being an extension for Github.js, the only requirement is to install and include Github.js before GitHub Extended.

Installation

You can install GitHub Extended by using npm:

npm install github-extended

Alternatively, you can install it via Bower:

bower install github-extended --save

Another possibility is to manually download it.

Methods

The sections below describe the methods provided.

repository.search(string, options = {})

Searches files and folders

repository.mergePullRequest(pullRequest, options = {})

Merges a pull request

repository.remove(branchName = 'master', path = '')

Deletes a file or a folder and all of its content from a given branch

repository.fork()

Creates a fork of the repository

License

GitHub Extended is dual licensed under MIT and GPL-3.0.

Author

Aurelio De Rosa (@AurelioDeRosa)