File: doc/README

* What is this?
------------------------------------------------------
xArray stands for eXtended array. It allows you to manipulate arrays
in a different manner. It is modeled after Enumerable/Array objects of
prototype.js javascript library, and incorporates most of the 
functionality found there.


* What can I do with this?
------------------------------------------------------
There are a lot of methods for doing all kinds of stuff on your arrays:
regex matching on keys and values, sorting on keys, values, properites and 
method results, property plucking and method invoking (for arrays of objects), 
selecting and rejecting members based on certain criteria...
Most methods accept (expect) a lambda/callback parameter - a function that will
be executed on all members - so the criteria can be as dynamic and programatic 
as you need it to be.


* What do I need to run this?
------------------------------------------------------
PHP 4+


* How do I use this?
------------------------------------------------------
Check the examples in "example" directory. You can also take a look at 
comments in the source, or run PhpDocumentor (http://www.phpdoc.org) over 
it to get a more readable documentation.


* Aaargh! I've found a bug!
  - OR -
* This xArray stuff is working fine for me.
  - OR -
* Dis nuh workin.
  - OR -
* Dude, you rock!
------------------------------------------------------
Let me know: malatestapunk@gmail.com