Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 1.58 KB

File metadata and controls

53 lines (37 loc) · 1.58 KB

jquery.github.js 1.0.0

This plugin is the easiest way to display your most recent GitHub contributions with jQuery and Bootstrap. Thanks to Bootstrap, it's responsive from large displays down to phones. In the future I may provide a hosted version on GitHub Pages.

Setup

To get started you'll need to include the latest versions of jQuery and Bootstrap on your page. Then simply add a layer where you want the plugin to render:

<div id="github">
	<!-- plugin will render here... -->
</div>

And initialize it when the document loads:

$(document).ready(function(){
	$('#github').github({
		// put your username here
		   'user': 'you',
		// number of commits to show
		'display': 5
		// optional: client_id and client_secret
	});
}); 

A more detailed example is available here.

Build

To build the code you'll need uglifyjs. Follow these steps:

$ git clone git://github.com/kmacrow/jquery.github.js.git
$ sudo npm install -g uglifyjs
$ make

Authors

Kalan MacRow
@KalanMacRow, Personal page

License

This code is licensed under the MIT license. It is provided "as is", without warranty of any kind, express or implied. Please see the LICENSE included with the code.