readme

README.md

@@ -1,3 +1,7 @@
+_this plugin is being developed as part of some articles I'm writing on [JavaScriptPlayground](http://www.javascriptplayground.com). It's not finished yet_
+
+
+---
 # jQuery Pullquote
 
 A jQuery plugin to pull out quotes into new elements for styling on the page.
@@ -15,25 +19,31 @@ In your web page:
 <script src="dist/jquery.pullquote.min.js"></script>
 <script>
 jQuery(function($) {
-  $.awesome(); // "awesome"
+  $("p span").pullQuote({
+    outputClass: "pullquote",
+    outputElem: "blockquote",
+    insertAfter: "elem"
+  });
 });
 </script>
 ```
 
+Changing those options as needed. PullQuote will then take the text within the selector, and create a new element after `insertAfter` with that text within. 
+
 ## Documentation
 _(Coming soon)_
 
 ## Examples
 _(Coming soon)_
 
 ## Contributing
-In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt](https://github.com/cowboy/grunt).
+In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt](https://github.com/cowboy/grunt). Make sure all tests pass before making a pull request.
 
 _Also, please don't edit files in the "dist" subdirectory as they are generated via grunt. You'll find source code in the "src" subdirectory!_
 
 ## Release History
-_(Nothing yet)_
+27th April: 0.1.0
 
 ## License
-Copyright (c) 2012 Jack Franklin  
+Copyright (c) 2012 Jack Franklin
 Licensed under the MIT, GPL licenses.