=== Plugin Name ===
Contributors: f13dev
Donate link: http://f13dev.com/wordpress-plugin-github-profile-widget/
Tags: github, widget, profile, code
Requires at least: 3.0.1
Tested up to: 4.9.8
Stable tag: 1.1
License: GPLv3 or later
License URI: http://www.gnu.org/licenses/gpl-3.0.html

Add a snapshot of your GitHub profile to your website with with this widget.

== Description ==

If you are a programmer who uses GitHub then why not share your coding projects via your WordPress blog by adding a snapshot
of your profile as a widget

Simply add the widget to your preferred location and enter your GitHub username.

Features include:

* Cached using Transient
* Displays your GitHub profile image
* Shows your GitHub bio, if set
* Shows your Location, email address & blog URL if set
* Provides links to your followers, following and starred repositories

== Installation ==

This section describes how to install the plugin and get it working.

1. Upload the plugin files to the `/wp-content/plugins/plugin-name` directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress
3. Add the widget to your desired location in Appearance->Widgets
4. Enter your GitHub username in the appropriate field
5. If desired, add a GitHub API Token and/or alter the cache timeout.

== Frequently Asked Questions ==

= Is a GitHub API token required =

No... Although it is recommended, especially if you wish to have the cache timeout set to a low value, or if you require regular access to the GitHub API through other areas of your website.

== Screenshots ==

1. An example showing the GitHub Mini Profile Widget in use.

== Changelog ==

= 1.0 =
* Initial release

= 1.1 =
* Correcting URL of public gists

== Upgrade Notice ==

= 1.0 =
* Initial release

= 1.1 =
* Correcting URL of public gists