Get the members of github organisations with complete details
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.
src
.editorconfig
.gitignore
.npmignore
.travis.yml
CONTRIBUTING.md
Cakefile
HISTORY.md
LICENSE.md
README.md
package.json

README.md

Get Members

Build Status NPM version Dependency Status Development Dependency Status
Gittip donate button Flattr donate button PayPayl donate button BitCoin donate button Wishlist browse button

Fetch all the members of all the specified github organisations with their complete details

Install

NPM

  • Use: require('getmembers')
  • Install: npm install --save getmembers

Usage

// Create our getmembers instance
var getter = require('getmembers').create({
	githubClientId: null,      // optional, will try process.env.GITHUB_CLIENT_ID
	githubClientSecret: null,  // optional, will try process.env.GITHUB_CLIENT_SECRET
	log: console.log           // optional, arguments: level, message... 
});

// Fetch all the members on these github orgs
getter.fetchMembersFromOrgs(['bevry'], function(err, members){
	// Fetch the direct results
	console.log(err, members);

	// Get the combined listing
	console.log(getter.getMembers());
});

Contributors are returned as an array of contributor objects, here is an example contributor object:

{
	name: "Benjamin Lupton",
	email: "b@lupton.cc",
	url: "https://github.com/balupton",
	username: "balupton",
	text: "Benjamin Lupton <b@lupton.cc> (https://github.com/balupton)",
	orgs: {
		"bevry": "https://github.com/bevry"
	},
	profile: {
		// https://api.github.com/users/balupton
	}
}

History

Discover the change history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Gittip donate button Flattr donate button PayPayl donate button BitCoin donate button Wishlist browse button

Contributors

No contributors yet! Will you be the first? Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Licensed under the incredibly permissive MIT license

Copyright © 2014+ Bevry Pty Ltd us@bevry.me (http://bevry.me)