Skip to content
This repository has been archived by the owner on Jun 15, 2021. It is now read-only.

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fat committed May 9, 2011
1 parent 033af66 commit f4df399
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions 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 <code>add</code> and <code>remove</code> 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?
-------------------------------

<h3>domready</h3>

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

<h3>DOM queries</h3>

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

<h3>Manipulation</h3>

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

<h3>Events</h3>

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

<h3>No Conflict</h3>

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)
<iframe id="fiddle-example" src="http://jsfiddle.net/yakWA/2/embedded/"></iframe>

0 comments on commit f4df399

Please sign in to comment.