		{
		"name": "github-api",
		"version": "0.11.2",
		"version": "1.0.0",
		"license": "BSD-3-Clause-Clear",
		"description": "A higher-level wrapper around the Github API.",
		"main": "src/github.js",
		"main": "dist/components/GitHub.js",
		"contributors": [
		"Ændrew Rininsland <aendrew.rininsland@thetimes.co.uk> (http://www.aendrew.com)",
		"Aurelio De Rosa <a.derosa@audero.it> (http://www.audero.it/)",
		"Clay Reimann <clayreimann@gmail.com> (http://clayreimann.me)",
		"Michael Aufreiter (http://substance.io)"
		],
		"readmeFilename": "README.md",
		"scripts": {
		"clean": "gulp clean",
		"build": "gulp build",
		"test": "mocha --opts ./mocha.opts test/*.spec.js",
		"test-verbose": "DEBUG=github* npm test",
		"test-browser": "",
		"lint": "gulp lint",
		"generate-docs": "node_modules/.bin/jsdoc -c .jsdoc.json --verbose",
		"codecov": "node_modules/.bin/codecov",
		"show-coverage-html": "open coverage/lcov-report/index.html"
		},
		"babel": {
		"presets": [
		"es2015"
		],
		"plugins": [
		[
		"transform-es2015-modules-umd",
		{
		"globals": {
		"es6-promise": "Promise"
		}
		}
		]
		],
		"env": {
		"development": {
		"sourceMaps": "inline"
		}
		}
		},
		"files": [
		"dist/*",
		"lib/*"
		],
		"dependencies": {
		"axios": "https://github.com/github-tools/axios.git",
		"base-64": "^0.1.0",
		"axios": "^0.10.0",
		"debug": "^2.2.0",
		"es6-promise": "^3.0.2",
		"js-base64": "^2.1.9",
		"utf8": "^2.1.1"
		},
		"devDependencies": {
		"babel-core": "^6.7.7",
		"babel-plugin-transform-es2015-modules-umd": "^6.5.0",
		"babel-preset-es2015": "^6.5.0",
		"babel-register": "^6.7.2",
		"babelify": "^7.3.0",
		"browserify": "^13.0.0",
		"browserify-istanbul": "^0.2.1",
		"chai": "^3.4.1",
		"codecov": "^1.0.1",
		"del": "^2.2.0",
		"gulp": "^3.9.0",
		"gulp-babel": "^6.1.2",
		"gulp-eslint": "^2.0.0",
		"gulp-jscs": "^3.0.2",
		"gulp-jscs-stylish": "^1.3.0",
		"gulp-jshint": "^2.0.0",
		"gulp-rename": "^1.2.2",
		"gulp-sourcemaps": "^1.6.0",
		"gulp-uglify": "^1.5.1",
		"istanbul": "^0.4.2",
		"jshint": "^2.9.1",
		"jshint-stylish": "^2.1.0",
		"karma": "^0.13.19",
		"karma-browserify": "^4.4.2",
		"karma-chai": "^0.1.0",
		"karma-coverage": "^0.5.3",
		"karma-json-fixtures-preprocessor": "0.0.6",
		"karma-mocha": "^0.2.1",
		"karma-mocha-reporter": "^1.1.5",
		"karma-phantomjs-launcher": "^0.2.3",
		"karma-sauce-launcher": "^0.3.0",
		"jsdoc": "^3.4.0",
		"minami": "^1.1.1",
		"mocha": "^2.3.4",
		"must": "^0.13.1",
		"vinyl-buffer": "^1.0.0",
		"vinyl-source-stream": "^1.1.0"
		},
		"scripts": {
		"test": "gulp test && gulp lint",
		"lint": "gulp lint",
		"codecov": "cat coverage/*/lcov.info \| codecov"
		},
		"repository": {
		@@ -54,9 +88,2 @@ "type": "git",
		],
		"contributors": [
		"Ændrew Rininsland <aendrew.rininsland@thetimes.co.uk> (http://www.aendrew.com)",
		"Aurelio De Rosa <a.derosa@audero.it> (http://www.audero.it/)",
		"Michael Aufreiter (http://substance.io)"
		],
		"license": "BSD-3-Clause-Clear",
		"readmeFilename": "README.md",
		"gitHead": "aa8aa3c8cd5ce5240373d4fd1d06a7ab4af41a36",
		@@ -63,0 +90,0 @@ "bugs": {

515

README.md

		# Github.js

		[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/michael/github?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Stories in Ready](https://badge.waffle.io/michael/github.png?label=ready&title=Ready)](https://waffle.io/michael/github) [![Build Status](https://travis-ci.org/michael/github.svg?branch=master)](https://travis-ci.org/michael/github) [![codecov.io](https://codecov.io/github/michael/github/coverage.svg?branch=master)](https://codecov.io/github/michael/github?branch=master)
		[![Downloads per month](https://img.shields.io/npm/dm/github-api.svg?maxAge=2592000)][npm-package]
		[![Latest version](https://img.shields.io/npm/v/github-api.svg?maxAge=3600)][npm-package]
		[![Gitter](https://img.shields.io/gitter/room/michael/github.js.svg?maxAge=2592000)][gitter]
		[![Travis](https://img.shields.io/travis/michael/github.svg?maxAge=60)][travis-ci]
		<!-- [![Codecov](https://img.shields.io/codecov/c/github/michael/github.svg?maxAge=2592000)][codecov] -->

		Github.js provides a minimal higher-level wrapper around git's [plumbing commands](http://git-scm.com/book/en/Git-Internals-Plumbing-and-Porcelain), exposing an API for manipulating GitHub repositories on the file level. It was formerly developed in the context of [Prose](http://prose.io), a content editor for GitHub.
		Github.js provides a minimal higher-level wrapper around Github's API. It was concieved in the context of
		[Prose][prose], a content editor for GitHub.

		## Docs
		Read the [docs][docs]

		## Installation
		Github.js is available from `npm` or (soon) [cdnjs][cdnjs].

		Either grab `github.js` from this repo or install Github.js via npm:

		```
		@@ -15,20 +22,9 @@ npm install github-api

		Alternatively, you can install the library using Bower:

		```
		bower install github-api
		```

		## Compatibility
		Github.js is tested on Node:
		* 0.10
		* 0.12
		* 4.x
		* 5.x

		[![Sauce Test Status](https://saucelabs.com/browser-matrix/githubjs.svg)](https://saucelabs.com/u/githubjs)

		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](http://blogs.msdn.com/b/ieinternals/archive/2010/05/13/xdomainrequest-restrictions-limitations-and-workarounds.aspx).
		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
		@@ -40,439 +36,78 @@

		## Usage
		## Samples

		Create a Github instance.
		```javascript
		/*
		Data can be retrieved from the API either using callbacks (as in versions < 1.0)
		or using a new promise-based API. For now the promise-based API just returns the
		raw HTTP request promise; this might change in the next version.
		*/
		var GitHub = require('github-api');

		```js
		var github = new Github({
		username: "YOU_USER",
		password: "YOUR_PASSWORD",
		auth: "basic"
		});
		```
		// unauthenticated client
		var gh = new GitHub();
		var gist = gh.getGist(); // not a gist yet
		gist.create({
		public: true,
		description: 'My first gist',
		files: {
		"file1.txt": {
		contents: "Aren't gists great!"
		}
		}
		}).then(function(httpResponse) {
		// Promises!
		var gist = httpResponse.data;
		gist.read(function(err, gist, xhr) {
		// if no error occurred then err == null

		Or if you prefer OAuth, it looks like this:
		// gist == httpResponse.data

		```js
		var github = new Github({
		token: "OAUTH_TOKEN",
		auth: "oauth"
		// xhr == httpResponse
		});
		});
		```

		You can use either:
		* Authorised App Tokens (via client/secret pairs), used for bigger applications, created in web-flows/on the fly
		* Personal Access Tokens (simpler to set up), used on command lines, scripts etc, created in GitHub web UI
		```javascript
		var GitHub = require('github-api');

		See these pages for more info:
		// basic auth
		var gh = new GitHub({
		username: 'FOO',
		password: 'NotFoo'
		});

		[Creating an access token for command-line use](https://help.github.com/articles/creating-an-access-token-for-command-line-use)

		[Github API OAuth Overview](http://developer.github.com/v3/oauth)

		Enterprise Github instances may be specified using the `apiUrl` option:

		```js
		var github = new Github({
		apiUrl: "https://serverName/api/v3",
		...
		var me = gh.getUser();
		me.getNotification(function(err, notifcations) {
		// do some stuff
		});
		```

		## Repository API


		```js
		var repo = github.getRepo(username, reponame);
		var clayreimann = gh.getUser('clayreimann');
		clayreimann.getStarredRepos()
		.then(function(httpPromise) {
		var repos = httpPromise.data;
		});
		```

		Show repository information
		```javascript
		var GitHub = require('github-api');

		```js
		repo.show(function(err, repo) {});
		```

		Delete a repository

		```js
		repo.deleteRepo(function(err, res) {});
		```

		Get contents at a particular path in a particular branch.

		```js
		repo.contents(branch, "path/to/dir", function(err, contents) {});
		```

		Fork repository. This operation runs asynchronously. You may want to poll for `repo.contents` until the forked repo is ready.

		```js
		repo.fork(function(err) {});
		```

		List forks.

		```js
		repo.listForks(function(err, forks) {});
		```

		Create new branch for repo. You can omit oldBranchName to default to "master".

		```js
		repo.branch(oldBranchName, newBranchName, function(err) {});
		```

		List Pull Requests.

		```js
		var state = 'open'; //or 'closed', or 'all'
		repo.listPulls(state, function(err, pullRequests) {});
		```

		Get details of a Pull Request.

		```js
		var pullRequestID = 123;
		repo.getPull(pullRequestID, function(err, pullRequestInfo) {});
		```

		Create Pull Request.

		```js
		var pull = {
		title: message,
		body: "This pull request has been automatically generated by Prose.io.",
		base: "gh-pages",
		head: "michael" + ":" + "prose-patch"
		};
		repo.createPullRequest(pull, function(err, pullRequest) {});
		```

		Retrieve all available branches (aka heads) of a repository.

		```js
		repo.listBranches(function(err, branches) {});
		```

		Get list of statuses for a particular commit.

		```js
		repo.getStatuses(sha, function(err, statuses) {});
		```

		Store content at a certain path. If the file specified in the path exists, the content is updated. If the file doesn't exist, it's created on the fly. You can also provide an optional object literal, (`options` in the example below) containing information about the author and the committer.

		```js
		var options = {
		author: {name: 'Author Name', email: 'author@example.com'},
		committer: {name: 'Committer Name', email: 'committer@example.com'},
		encode: true // Whether to base64 encode the file. (default: true)
		}
		repo.write('master', 'path/to/file', 'YOUR_NEW_CONTENTS', 'YOUR_COMMIT_MESSAGE', options, function(err) {});
		```

		Not only can you can write files, you can of course read them.

		```js
		repo.read('master', 'path/to/file', function(err, data) {});
		```

		Move a file from A to B.

		```js
		repo.move('master', 'path/to/file', 'path/to/new_file', function(err) {});
		```

		Remove a file.

		```js
		repo.remove('master', 'path/to/file', function(err) {});
		```

		Get information about a particular commit.

		```js
		repo.getCommit('master', sha, function(err, commit) {});
		```

		Exploring files of a repository is easy too by accessing the top level tree object.

		```js
		repo.getTree('master', function(err, tree) {});
		```

		If you want to access all blobs and trees recursively, you can add `?recursive=true`.

		```js
		repo.getTree('master?recursive=true', function(err, tree) {});
		```

		Given a filepath, retrieve the reference blob or tree sha.

		```js
		repo.getSha('master', '/path/to/file', function(err, sha) {});
		```

		For a given reference, get the corresponding commit sha.

		```js
		repo.getRef('heads/master', function(err, sha) {});
		```

		Create a new reference.

		```js
		var refSpec = {
		"ref": "refs/heads/my-new-branch-name",
		"sha": "827efc6d56897b048c772eb4087f854f46256132"
		};
		repo.createRef(refSpec, function(err) {});
		```

		Delete a reference.

		```js
		repo.deleteRef('heads/gh-pages', function(err) {});
		```

		Get contributors list with additions, deletions, and commit counts.

		```js
		repo.contributors(function(err, data) {});
		```

		Check if a repository is starred.

		```js
		repo.isStarred(owner, repository, function(err) {});
		```

		Star a repository.

		```js
		repo.star(owner, repository, function(err) {});
		```

		Unstar a repository.

		```js
		repo.unstar(owner, repository, function(err) {});
		```

		## User API


		```js
		var user = github.getUser();
		```

		List repositories of the authenticated user, including private repositories and repositories in which the user is a collaborator and not an owner.

		```js
		user.repos(options, function(err, repos) {});
		```

		List organizations the authenticated user belongs to.

		```js
		user.orgs(function(err, orgs) {});
		```

		List authenticated user's gists.

		```js
		user.gists(function(err, gists) {});
		```

		List unread notifications for the authenticated user.

		```js
		user.notifications(options, function(err, notifications) {});
		```

		Show user information for a particular username. Also works for organizations. Pass in a falsy value (null, '', etc) for 'username' to retrieve user information for the currently authorized user.

		```js
		user.show(username, function(err, user) {});
		```

		List public repositories for a particular user.

		```js
		user.userRepos(username, function(err, repos) {});
		```

		List starred repositories for a particular user.

		```js
		user.userStarred(username, function(err, repos) {});
		```

		Create a new repo for the authenticated user

		```js
		user.createRepo({"name": "test"}, function(err, res) {});
		```
		Repo description, homepage, private/public can also be set.
		For a full list of options see the docs [here](https://developer.github.com/v3/repos/#create)


		List repositories for a particular organization. Includes private repositories if you are authorized.

		```js
		user.orgRepos(orgname, function(err, repos) {});
		```

		List all gists of a particular user. If username is ommitted gists of the current authenticated user are returned.

		```js
		user.userGists(username, function(err, gists) {});
		```

		## Gist API

		```js
		var gist = github.getGist(3165654);
		```

		Read the contents of a Gist.

		```js
		gist.read(function(err, gist) {

		// token auth
		var gh = new GitHub({
		token: 'MY_OAUTH_TOKEN'
		});
		```

		Updating the contents of a Gist. Please consult the documentation on [GitHub](http://developer.github.com/v3/gists/).

		```js
		var delta = {
		"description": "the description for this gist",
		"files": {
		"file1.txt": {
		"content": "updated file contents"
		},
		"old_name.txt": {
		"filename": "new_name.txt",
		"content": "modified contents"
		},
		"new_file.txt": {
		"content": "a new file"
		},
		"delete_this_file.txt": null
		}
		};

		gist.update(delta, function(err, gist) {

		});
		var yahoo = gh.getOrganization('yahoo');
		yahoo.getRepos(function(err, repos) {
		// look at all the repos!
		})
		```
		## Issues API

		```js
		var issues = github.getIssues(username, reponame);
		```

		To read all the issues of a given repository

		```js
		issues.list(options, function(err, issues) {});
		```

		To comment in a issue

		```js
		issues.comment(issue, comment,function(err, comment) {});
		```

		## Search API

		```js
		var search = github.getSearch(query);
		```

		### Search repositories

		Suppose you want to search for popular Tetris repositories written in Assembly. Your query might look like this:

		```js
		var search = github.getSearch("tetris+language:assembly&sort=stars&order=desc");
		search.repositories(options, function (err, repositories) {});
		```

		### Search code

		Suppose you want to find the definition of the addClass function inside jQuery. Your query would look something like this:

		```js
		var search = github.getSearch("addClass+in:file+language:js+repo:jquery/jquery");
		search.code(options, function (err, codes) {});
		```

		### Search issues

		Let’s say you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this:

		```js
		var search = github.getSearch("windows+label:bug+language:python+state:open&sort=created&order=asc");
		search.issues(options, function (err, issues) {});
		```

		### Search users

		Imagine you’re looking for a list of popular users. You might try out this query:

		```js
		var search = github.getSearch("tom+repos:%3E42+followers:%3E1000");
		search.users(options, function (err, users) {});
		```

		Here, we’re looking at users with the name Tom. We’re only interested in those with more than 42 repositories, and only if they have over 1,000 followers.


		## Change Log

		### 0.10.X

		Create and delete repositories
		Repos - getCommit

		### 0.9.X

		Paging (introduced at tail end of 0.8.X, note: different callbacks for success & errors now)

		### 0.8.X

		Fixes and tweaks, simpler auth, CI tests, node.js support, Raw+JSON, UTF8, plus:
		Users - follow, unfollow, get info, notifications
		Gists - create
		Issues - get
		Repos - createRepo, deleteRepo, createBranch, star, unstar, isStarred, getCommits, listTags, listPulls, getPull, compare
		Hooks - listHooks, getHook, createHook, editHook, deleteHook

		### 0.7.X

		Switched to a native `request` implementation (thanks @mattpass). Adds support for GitHub gists, forks and pull requests.

		### 0.6.X

		Adds support for organizations and fixes an encoding issue.

		### 0.5.X

		Smart caching of latest commit sha.

		### 0.4.X

		Added support for [OAuth](http://developer.github.com/v3/oauth/).

		### 0.3.X

		Support for Moving and removing files.

		### 0.2.X

		Consider commit messages.

		### 0.1.X

		Initial version.
		[cdnjs]: https://cdnjs.com/
		[codecov]: https://codecov.io/github/michael/github?branch=master
		[travis-ci]: https://travis-ci.org/michael/github
		[gitter]: https://gitter.im/michael/github
		[npm-package]: https://www.npmjs.com/package/github-api
		[prose]: http://prose.io
		[xhr-link]: http://blogs.msdn.com/b/ieinternals/archive/2010/05/13/xdomainrequest-restrictions-limitations-and-workarounds.aspx
		[docs]: http://clayreimann.me/github/

.editorconfig

.jscsrc

.jshintrc

.npmignore

.travis.yml

bower.json

dist/github.bundle.min.js

dist/github.bundle.min.js.map

dist/github.min.js

dist/github.min.js.map

gulpfile.js

karma.conf.js

src/github.js

test/gh.png

test/mocha.opts

test/test.auth.js

test/test.gist.js

test/test.issue.js

test/test.repo.js

test/test.search.js

test/test.user.js

test/user.json

test/vendor/Blob.js

github-api - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics

Worsened metrics

Dependency changes