Permalink
Browse files

First Commit

  • Loading branch information...
JoelSutherland committed Apr 2, 2012
0 parents commit 94c6c35814aea01a489382f6cfeecfdca3aeee55
Showing with 19 additions and 0 deletions.
  1. +19 −0 README.markdown
@@ -0,0 +1,19 @@
+# GitHub jQuery Repo Widget
+
+Drop this script on your page and it will build you a beautiful widget that displays the status of your GitHub repo.
+
+## What does it look like?
+
+Coming soon. (Need to double check how to do this with markdown)
+
+## How do I use it?
+
+Everwhere you want a widget to be placed, add the following markup:
+
+ <div class="github-widget" data-repo="JoelSutherland/GitHub-jQuery-Repo-Widget"></div>
+
+Then include the javascript file somewhere after you've include jQuery:
+
+ <script type="text/javascript" src="jquery.githubRepoWidget.min.js"></script>
+
+That's it! All of the styling is included and image assets are pulled from GitHub.

0 comments on commit 94c6c35

Please sign in to comment.