From f4df3995a4ddb4ce223a5ac8752e1be9d753558f Mon Sep 17 00:00:00 2001 From: Jacob Thornton Date: Mon, 9 May 2011 16:16:19 -0700 Subject: [PATCH] add readme --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..de8c11f --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +THE JEESH +--------- + +The Jeesh is like a starter pack for ender. At only *7.5k* the Jeesh can help you build anything from small prototypes to providing a solid base for large-scale rich application for desktop and mobile devices. At it's core, it's a collection of packages that we've found particularly useful for major use-case development endeavors -- but we encourage use to add and remove packages to really make it your own. Currently, the Jeesh includes: + + * domReady - a cross-browser [domReady](github.com/ded/domready) + * Qwery - a fast light-weight [selector engine](https://github.com/ded/qwery) + * Bonzo - a bullet-proof [DOM utility](https://github.com/ded/bonzo) + * Bean - a multi-platform [Event provider](https://github.com/fat/bean) + +BUILDING +-------- + +To build the jeesh... just run: + + ender -b jeesh + + +WHAT DOES THIS SETUP LOOK LIKE? +------------------------------- + +

domready

+ + $.domReady(function () {...}) + +

DOM queries

+ + $('#boosh a[rel~="bookmark"]').each(function (el) { ... }); + +

Manipulation

+ + $('#boosh p a[rel~="bookmark"]').hide().html('hello').css({ + color: 'red', + 'text-decoration': 'none' + }).addClass('blamo').after('✓').show(); + +

Events

+ + $('#content a').bind('keydown input', handler); + $('#content a').emit('customEvent'); + $('#content a').remove('click.myClick'); + +

No Conflict

+ + var ender = $.noConflict(); // return '$' back to its original owner + ender('#boosh a.foo').each(fn); + + +GETTING STARTED WITH THE JEESH +------------------------------ +If you're looking to test drive this setup, have a play with [the compiled source](http://ender-js.s3.amazonaws.com/ender.min.js) + \ No newline at end of file