=== Plugin Name ===
Contributors: stevepuddick
Tags: rating, stars, post, user rating
Requires at least: 3.5
Tested up to: 4.4.1
Stable tag: 1.0.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

A fun and creative way to let your site visitors rate your posts, pages, and more! 

== Description ==

Custom Ratings is a fun and creative tool that allows your visitors to interact and rate your site content. You can choose from a selection of built in "rating objects" or upload your own (aka an image file). Do you have a blog about coffee? Let your visitors rate your post 5/5 coffee mugs. Perhaps you have a blog about fitness. Visitors can rate your posts 1, 2, 3, 4, or 5 barbells out of 5. Choose a rating object that suits the topic of your website. All text snippets are customizable; you can add inside jokes and jargon related to your website topic. 

You have full control over what post types Custom Ratings gets applied to. The rating system is also fully ajax based, so it won't cause problems if you use caching plugins such as W3c total cache or WP Super Cache.  

So add some personality to your website and install Custom Ratings today!

Thanks to the following open source projects which Custom Ratings has utilized:

* [Ractive](http://www.ractivejs.org/ "Ractive")
* [Spectrum](https://bgrins.github.io/spectrum/ "Spectrum")


== Installation ==

1. From the plugin managment page in the WordPress admin, search for "Custom Ratings" 
2. Select "Custom Ratings" from the list of results and click on "install"
3. "Custom Ratings" has now been installed. In the Wordpress admin, go to "Settings" > "Custom Ratings"
4. Choose your star type from the included options, or upload your own image (will be uploaded to media library)
5. Select which post types "Custom Ratings" should be applied to. Posts are selected by default
6. Select where the rating tally and vote display positions should be in relation to the content 
7. Select the background color, if desired
8. Edit the various text snippets, if desired
9. Take a look at a "single" or "archive" page of a selected post type (or any other page which call the_excerpt or the_content) and you will see the custom ratings components appended


== Frequently Asked Questions ==

= What is a rating tally? =

The rating tally is a non-interactive display of the current ratings of a post. This is displayed visually as the number of stars out of a total of 5 stars. This hooks into the "the_excerpt" filter. Where ever that filter is used, the Custom Ratings rating tally will be displayed (unless disabled in the settings). 

= What is a vote display? =

The vote display is an interactive component which allows users to rate a post. This rating can be 1, 2, 3, 4, or 5 stars out of 5. The vote display hooks into "the_content" filter.  Where ever that filter is used, the Custom Ratings vote display will be displated (unless disabled in the settings). 

= What is a "star" =

In Custom Ratings, a "star" is a general term used to describe the rating object. A "star" can be a cupcake, heart, star, smiley face, shoe, etc.

= Will this work with WPML? =

Custom Ratings has been designed with WPML compatiblity in mind. If you use Custom Ratings with WPML you likely won't run into problems, in most cases. There are some edge cases where some fixes are needed with the current version. 

= Does this work with custom post types? =

Yes. You can choose which (if any) custom post types Custom Ratings gets applied to.


== Screenshots ==

1. This is the Custom Ratings settings page in the WordPress admin.
2. For many themes, archive pages display the excerpt of posts. A non-interactive tally of the votes can be attached to the excerpt.
3. On single pages (and any page executing the_content action) an interactive voting component can be displayed. This screenshot depicts the interface before the user has voted.
4. Continuing from screenshot 3, this is what the interface looks like after the user has voted.
5. Rating information is available on the admin edit page for posts.

== Changelog ==

= 1.0.0 =
* Initial version


== Roadmap ==

* Option to enfore 1 vote per post, per IP address
* Caching time controls of rating data ajax request
* Option to only show rating after a certain number of votes
* Option to show rating once a certain score is reached
* Full WPML compatibility