readme.txt

=== Fancy Github Activity ===
Contributors: stopspazzing
Tags: github, activity, feed, fancy
Requires at least: 4.5
Tested up to: 4.9
Stable tag: trunk
Donate link: https://paypal.me/stopspazzing
License: MIT
License URI: https://github.com/stopspazzing/fancy-github-activity/blob/master/LICENSE.md

Displays Github activity in a fancy way via shortcode.

== Description ==

Displays Github activity in a fancy way via shortcode which can be used in posts, pages, or widgets.

== Installation ==

1. Upload the plugin files to the `/wp-content/plugins/fancy-github-activity` directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress
3. Use shortcode [fancy-github-activity] where you would like it. Configurable options below.

Options:

* username="stopspazzing" // required
* repository="" // optional
* limit="20" // optional

Example:
<code>[fancy-github-activity username="stopspazzing"]</code>

== Frequently Asked Questions ==

= What is the plugin license? =

* This plugin is released under a MIT license.

== Screenshots ==

1. Shortcode in action on a page.

== Changelog ==

= 1.0.3 =
* Code cleanup. Removed redundancies. Added plugin icon.

= 1.0.2 =
* Updated to latest code from [caseyscarborough](https://github.com/caseyscarborough/github-activity).
* Verified works on 4.9.x WordPress.

= 1.0.1 =
* Compliance with Wordpress Plugins requirements.
* Completely working the way it should.
* First release to Wordpress.

= 0.1 =
* Initial launch - unreleased

== Upgrade Notice ==

= 1.0.1 =

* Initial Version.

== Notes ==

* Languages: PHP and Javascript
* Credits: [caseyscarborough](https://github.com/caseyscarborough/github-activity) for his awesome github activity code.
* Created this because didn't like the bland looks of current Wordpress Github activity plugins.