mirror of
https://github.com/whoisclebs/lodash.git
synced 2026-02-04 17:07:49 +00:00
Cleanup and prep for v0.2.0.
Former-commit-id: 27fb5b6ce649bedae9ba8127278322a037075e41
This commit is contained in:
42
README.md
42
README.md
@@ -1,10 +1,12 @@
|
||||
# Lo-Dash <sup>v0.1.0</sup>
|
||||
|
||||
A drop-in replacement for [Underscore.js](https://github.com/documentcloud/underscore/) that delivers up to [8x performance improvements](http://jsperf.com/lodash-underscore#chart=bar), [bug fixes](https://github.com/bestiejs/lodash/blob/master/test/test.js#L88), and additional features.
|
||||
Lo-Dash, from the devs behind [jsPerf.com](http://jsperf.com), is a drop-in replacement for Underscore.js that delivers [performance improvements](http://jsperf.com/lodash-underscore#filterby=family), [additional features](https://github.com/bestiejs/lodash/wiki/The-Low-Down#wiki-features), and works on nearly all JavaScript platforms<sup><a name="fnref1" href="#fn1">1</a></sup>.
|
||||
|
||||
## Screencast
|
||||
## Screencasts
|
||||
|
||||
For more information check out [this screencast](http://dl.dropbox.com/u/513327/allyoucanleet/post/20/file/screencast.mp4) over Lo-Dash.
|
||||
For more information check out the series of screencasts over Lo-Dash:
|
||||
* [Introducing Lo-Dash](http://dl.dropbox.com/u/513327/allyoucanleet/post/20/file/screencast.mp4)
|
||||
* [Compiling and custom builds]()
|
||||
|
||||
## BestieJS
|
||||
|
||||
@@ -12,7 +14,7 @@ Lo-Dash is part of the BestieJS *"Best in Class"* module collection. This means
|
||||
|
||||
## Documentation
|
||||
|
||||
The documentation for Lo-Dash can be viewed here: [/doc/README.md](https://github.com/bestiejs/lodash/blob/master/doc/README.md#readme)
|
||||
The documentation for Lo-Dash can be viewed here: <http://lodash.com/docs>
|
||||
|
||||
Underscore's [documentation](http://documentcloud.github.com/underscore/) may also be used.
|
||||
|
||||
@@ -20,11 +22,32 @@ For a list of upcoming features, check out our [roadmap](https://github.com/best
|
||||
|
||||
## So What's The Secret?
|
||||
|
||||
Lo-Dash's performance is gained by avoiding native methods, instead opting for simplified non-ES5 compliant methods optimized for common usage, and by leveraging function compilation to reduce the number of overall function calls.
|
||||
Lo-Dash's performance is gained by avoiding slower native methods, instead opting for simplified non-ES5 compliant methods optimized for common usage, and by leveraging function compilation to reduce the number of overall function calls.
|
||||
|
||||
## What else?
|
||||
## Any New Features?
|
||||
|
||||
Lo-Dash comes with AMD loader support baked in, chainable `_.each`, and will [soon address](https://github.com/bestiejs/lodash/wiki/Roadmap) cross-browser object iteration issues.
|
||||
Lo-Dash comes with AMD loader support, chainable `_.each`, lazy `_.bind`, [and more](https://github.com/bestiejs/lodash/wiki/The-Low-Down#wiki-features)...
|
||||
|
||||
## Custom builds
|
||||
|
||||
Creating custom builds to keep your utility belt lightweight is easy.
|
||||
We handle all the method dependency and alias mapping for you.
|
||||
|
||||
Custom builds may be created in two ways:
|
||||
|
||||
1. Use the`include` argument to pass the names of the methods to include in the build.
|
||||
~~~ bash
|
||||
node build include=each,filter,map,noConflict
|
||||
node build include="each, filter, map, noConflict"
|
||||
~~~
|
||||
|
||||
2. Use the `exclude` argument to pass the names of the methods to exclude from the build.
|
||||
~~~ bash
|
||||
node build exclude=isNaN,union,zip
|
||||
node build exclude="isNaN, union, zip"
|
||||
~~~
|
||||
|
||||
Custom builds are saved to `lodash.custom.js` and `lodash.custom.min.js`.
|
||||
|
||||
## Installation and usage
|
||||
|
||||
@@ -92,6 +115,11 @@ git submodule update --init
|
||||
|
||||
Feel free to fork and send pull requests if you see improvements!
|
||||
|
||||
## Footnotes
|
||||
|
||||
1. Lo-Dash has been tested in at least Chrome 5-19, Firefox 1.5-12, IE 6-9, Opera 9.25-11.64, Safari 3.0.4-5.1.3, Node.js 0.4.8-0.6.18, Narwhal 0.3.2, RingoJS 0.8, and Rhino 1.7RC3.
|
||||
<a name="fn1" title="Jump back to footnote 1 in the text." href="#fnref1">↩</a>
|
||||
|
||||
## Author
|
||||
|
||||
* [John-David Dalton](http://allyoucanleet.com/)
|
||||
|
||||
Reference in New Issue
Block a user