Better GitHub Widget
====================

A Wordpress widget to display your GitHub projects, it asks only for your
username. [Better GitHub Widget@WordPress.org](https://wordpress.org/extend/plugins/better-github-widget/)

Translate at [https://translate.foe-services.de/projects/better-github-widget](https://translate.foe-services.de/projects/better-github-widget)

INSTALL
-------

1. Get the content of this repo with `git clone` or as a zip
2. Upload the folder to `/wp-content/plugins/` directory
3. Activate the plugin through the 'Plugins' menu in WordPress
4. Under Appearance > Widgets you will see the "Better Github Widget". Drag it to your sidebar and place it where you want it to appear.
5. Add your Github username and configure the default settings (the number of projects to display and whether to show forked repositories)

SCREENSHOTS
-----------

![Widget in action](http://ceksblog.s3.amazonaws.com/bgw.png)

TODO
----

* Improve readme

Credits
-------

* Brandon Mathis for the original github.js script
* [Github WordPress Widget](http://wordpress.org/extend/plugins/github-profile-display/) for the
  inspiration
