Skip to content

Latest commit

 

History

History
37 lines (31 loc) · 1.09 KB

README.md

File metadata and controls

37 lines (31 loc) · 1.09 KB

widget.js

Library that provides small GitHub widgets to display various GitHub information directly into your website.
  • Enter the correct path to the widget.js file.
<script type="text/javascript" src="widget.js"></script>

####The overview widget.

<div class='some-classname'></div>

Simply call the relevant widget function and pass it a location and your GitHub username

<script>
    Widget.overview(".some-classname", "markogrady1");
</script>

This will result in the following widget.

checkmark

####The repo list widget.

<div class='another-classname'></div>

Simply call the relevant widget function and pass it a location, your GitHub username and the amount of repos you wish to display

<script>
    Widget.repos(".another-classname", "markogrady1", 10);
</script>

This will result in the following widget.

checkmark

NOTE: More widgets are on their way.