Skip to content

presidentbeef/github-commit-badge

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Github Commit Badge

This badge/banner can be used for displaying the latest (or a specific commit) for a github-project on your website.

The original looks like this:

This particular fork looks like this:

Usage

To use it on your website you'll have to put this somewhere. This means the .js file as well as the .css and the lib/ and img/ directories. To adjust the width of the whole thing look inside the style.css and set it for the container-class. I know that the way to define user/repos is still somewhat cumbersome. The "branch" entry is optional, default is "master".

<div id="github-commit-badge-container">
	<script type="text/javascript">
		var Badges = new Array();
		Badges[0] = new Object;
		Badges[0]["username"] = "heipei";
		Badges[0]["repo"] = "github-test";
		
		Badges[1] = new Object;
		Badges[1]["username"] = "heipei";
		Badges[1]["repo"] = "xmpp4r";
		Badges[1]["branch"] = "master";
		
	</script>
	<script type="text/javascript" src="github-commit-badge.js"></script>	
</div>

If you want to use it on something like WordPress you'll have to put HTML quotes around the content of the first script-block <script type="text/javascript"> </script>

Website

http://github.com/heipei/github-commit-badge/tree for now. See a working demonstration at http://hackvalue.de/~heipei/tmp/github-commit-badge/

FAQ

Q: Why is it called a badge when it's really more of a banner? A: Because I noticed that calling it banner increases the risk of it being filtered by AdBlock etc.

Q: Why does the JavaScript look like shit and is inconsistent? A: Because I don't know a thing about JavaScript and the million things that can and do fail. That's why there might be some workarounds ;)

Q: What libs are used (and what for)? A: jQuery for jQuery.getJSON and jQuery.each, datejs for Date.parse and md5 for md5_hex (for the gravatar). Also I learned a lot from DrNic's GitHub-badges http://github.com/drnic/github-badges/tree.

Author

Johannes 'heipei' Gilger heipei@hackvalue.de

About

This a very simple javascript banner which can display the latest commit of a Github-repo on a website.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%