Skip to content

Commit

Permalink
a new readme file added
Browse files Browse the repository at this point in the history
  • Loading branch information
zenorocha committed Oct 10, 2011
1 parent 2e7cfef commit 9bf4c09
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# jQuery Boilerplate

## A boilerplate for jump-starting jQuery plugins development.
So, you've tried your hand at writing jQuery plugins and you're comfortable putting together something that probably works. Awesome! Thing is, you think there might be better ways you could be writing them - you've seen them done a number of different ways in the wild, but aren't really sure what the differences between these patterns are or how to get started with them.

This project won't seek to provide a perfect solution to every possible pattern, but will attempt to cover a simple template for beginners and above. By using a basic defaults object, simple constructor for assigning the element to work with and extending options with defaults and a lightweight wrapper around the constructor to avoid issues with multiple instantiations.

## Have you created a plugin from our boilerplate?
Let us know! Soon we're going to have a gallery to display them all.

0 comments on commit 9bf4c09

Please sign in to comment.