Enter Project Name Here

Description

Enter Project Repo Description Here

The project is hosted on Github and is available for use under the MIT software license. You can report bugs and discuss features on the GitHub issues page, or send tweets to Enter Project Twitter Page Here.

Fork on Github »

Requirements

Enter Project Requirements Here

Optional Dependencies

Enter Project Optional Dependencies Here

Notable Features

Enter Notable Features Here

Browser Support

Enter Browser Support Here

Getting Started

Custom Download

Note: All of the plugin files are in the src directory (this includes both the JavaScript and CSS files). If you want to see an example page with all of the files included, look in the demos directory.

HTML

Enter HTML Instructions Here

          // Include appropriate HTML code if needed
          <div></div>

CSS

Enter CSS Instructions Here

          // Include appropriate CSS code if needed
          body {
          }

JavaScript

Enter JavaScript Instructions Here

              //Executes your code when the DOM is ready.  Acts the same as $(document).ready().
              $(function() {

              });

Options

Enter Options Instructions Here

Options

Name	Type	Default	Parameters
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here

Contributing

Take care to maintain the existing coding style. Add Enter Unit Testing Framework unit tests for any new or changed functionality. Lint and test your code using Enter Build Tool Here.

After you have verified your code, send a pull request to the Enter Project Name Here develop branch. After you send a pull request, you will hear back from me shortly after I review your code. You’ll find source code in the src subdirectory!

Extending

If you find that you need a feature that Enter Project Name Here does not currently support, either let me know via the Github issue tracker, or fork the project and and easily extend Enter Project Name Here!