# [WP GitHub Buttons](http://wordpress.org/plugins/wp-github-buttons/) #

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/michaeluno/wp-github-buttons/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/michaeluno/wp-github-buttons/?branch=master)

### Welcome to our GitHub Repository

WP GitHub Buttons is an open source WordPress plugin that displays GitHub buttons.

## Screenshots ##

Coming soon.

## Installation ##

- The latest development version can be found [here](https://github.com/michaeluno/wp-github-buttons/branches). 
<!-- - The latest stable version can be downloaded [here](http://downloads.wordpress.org/plugin/wp-github-buttons.latest-stable.zip). -->

1. Upload **`wp-github-buttons.php`** and other files compressed in the zip folder to the **`/wp-content/plugins/`** directory.,
2. Activate the plugin through the `Plugins` menu in WordPress.

## Usage ##

### Widget
1. Go to **Dashboard** -> **Appearance** -> **Widgets** and add the **WP GitHub Buttons** widget to your proffered sidebar.

### Shortcode and Function Parameters

Coming soon...


## Bugs ##
If you find an issue, let us know [here](https://github.com/michaeluno/wp-github-buttons/issues)!

## Support ##
This is a developer's portal for WP GitHub Buttons and should _not_ be used for support. Please visit the [support forums](http://wordpress.org/support/plugin/wp-github-buttons).

## Contributions ##
Anyone is welcome to contribute to WP GitHub Buttons.

There are various ways you can contribute:

1. Raise an [Issue](https://github.com/michaeluno/wp-github-buttons/issues) on GitHub.
2. Send us a Pull Request with your bug fixes and/or new features.
3. Provide feedback and suggestions on [enhancements](https://github.com/michaeluno/wp-github-buttons/issues?direction=desc&labels=Enhancement&page=1&sort=created&state=open).

## Supporting Future Development ##

If you like it, please rate and review it in the [WordPress Plugin Directory](http://wordpress.org/support/view/plugin-reviews/wp-github-buttons?filter=5). Also donation would be greatly appreciated. Thank you!

[![Donate with PayPal](https://www.paypal.com/en_US/i/btn/x-click-but04.gif)](http://en.michaeluno.jp/donate) 

## Copyright and License ##

### WP GitHub Buttons ###
Released under the [GPL v2](./LICENSE.txt) or later.
Copyright © 2014 Michael Uno

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.