#Plugin Name
A simple, lightweight jQuery plugin used to...
##Instructions
Include jQuery and the plugin in the head or footer of your page.
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<script src="/js/plugins/plugin.js"></script>
Initialize the plugin using the class, ID or element you're targeting.
$('el').plugin();
####Options
-
success: function()
A callback function that runs after the plugin, if the plugin is successful. -
error: function()
A callback function that runs after the plugin, if the plugin failed.
#####Example:
$(function() {
$('el').plugin({
success: function() {
console.log('The plugin was successful!');
},
error: function() {
console.log('The plugin encountered an error.');
}
});
});