=== Plugin Name ===
Contributors: alexmangini
Donate link: https://kolakube.com/comments-leaderboard/
Tags: top commentators, top commenters, top comments, comments list
Requires at least: 3.8
Tested up to: 4.8
Stable tag: 4.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Let the games begin! The Comments Leaderboard ranks your top commentators in a way that's sure to spark competition throughout your community.

== Description ==

The [The Comments Leaderboard](https://kolakube.com/comments-leaderboard/) was carefully designed to add a new twist to rewarding the top commentators on your blog and create a more addicting comment experience for your readers.

Each month, the 5 most active commenters throughout your blog will be listed and ranked from most comments posted to the least.

...but simply ranking on the Leaderboard isn't enough.

The lower their rank, the less visible their name will appear on the Leaderboards beautiful color spectrum (tip: you can even set a custom color to match your theme).

For their name and website link to get maximum exposure, they must outrank the competition by posting the most comments.

The overall leader gets a medal next to their name at the top of the list for the highest amount of visibility and prestige throughout your community.

But sadly, there is no comfort at the top.

The total amount of comments each leader posted for the month is displayed next to their name, making it easy for other commenters to overtake the top spot.

The Comments Leaderboard is the perfect way to reward your most engaging readers and fits perfectly in your blog's sidebar. Simply drag the Widget into place, write a title and description text, pick a color and your blog is ready for some serious comment action.

Just remember, keep your posts quality and you will attract quality comments.

Let the games begin!

== Installation ==

1. Upload `comments-leaderboard` to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Go to Appearance > Widgets and find the 'Comments Leaderboard' Widget. Drag it into your blog's sidebar (or other Widget area), fill in a title and color, and you're all done!

== Frequently Asked Questions ==

= How long do commenters rank for? =

All rankings last for one month. After a month, rankings will be reset and commenters will have to reclaim their status at the top.

= Can I exclude names from ranking? =

Yes, you can prevent multiple names from appearing by simply typing the name you wish to remove in the Widget setting. Be sure to separate each name with a comma (,).

= Can I list more than 5 commenters? =

As of now, you will need to make edits to the template file if you really need more than 5. In the future, you’ll be able to edit the Leaderboard template *safely* through your child theme, so be careful if you choose to edit the plugin files.

== Screenshots ==

1. By default, the Comments Leaderboard shows a red color spectrum.

2. This is what the Widget settings look like with some text filled in.

3. An alternative color scheme (tip: you can set any hex color code in the Widget settings)

== Changelog ==

= 1.1 =
* Added new “Footer Text” text field so you can place text after the Leaderboard.
* Improved widget options sanitization.

= 1.0 =
* Released to the world

== Upgrade Notice ==
* coming soon