jQuery Plugin Boilerplate

Boilerplate project to use as a starting point for jQuery plugins.

Usage

• Clone the repository
• Remove the .git directory
• Replace the placeholder strings within all project files
• Create a new repository:

   $ git init
   $ git add .
   $ git commit -m "Initial commit"

Placeholders

The following placeholders need to be replaced within the project:

{{ plugin_name }} - The name of the plugin e.g "My jQuery Plugin"

{{ plugin_slug }} - Slugified name of the plugin e.g "my-jquery-plugin"

{{ plugin_file }} - The plugin file name e.g "jquery.my-jquery-plugin.js"

{{ plugin_file_min }} - The minified plugin file name e.g "jquery.my-jquery-plugin.min.js"

{{ plugin_description }} - Description of the plugin

Use your IDE to perform a project wide search/replace.