Mirrors/lodash
1
0
Fork 0
mirror of https://github.com/whoisclebs/lodash.git synced 2026-02-09 18:37:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup the README.md.

Browse Source 
Former-commit-id: a01247eeb5c4602a3c209ed15753cbf2af32fdbf
This commit is contained in:
John-David Dalton
2012-05-21 12:01:36 -04:00
parent 754b1de597
commit 1da0498f74
2 changed files with 103 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -1,17 +1,16 @@
# Lo-Dash <sup>v0.1.0</sup>
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>.
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), bug fixes, and additional features.
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.
## Screencasts
For more information check out the series of screencasts over Lo-Dash:
For more information check out these screencasts over Lo-Dash:
* [Introducing Lo-Dash](http://dl.dropbox.com/u/513327/allyoucanleet/post/20/file/screencast.mp4)
* [Compiling and custom builds]()
## BestieJS
Lo-Dash is part of the BestieJS *"Best in Class"* module collection. This means we promote solid browser/environment support, ES5 precedents, unit testing, and plenty of documentation.
## Documentation
The documentation for Lo-Dash can be viewed here: <http://lodash.com/docs>
@@ -20,17 +19,15 @@ Underscore's [documentation](http://documentcloud.github.com/underscore/) may al
For a list of upcoming features, check out our [roadmap](https://github.com/bestiejs/lodash/wiki/Roadmap).
## So What's The Secret?
For a summary of bug fixes, changes, features, and optimizations, check out [wiki/The-Low-Down](https://github.com/bestiejs/lodash/wiki/The-Low-Down).
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.
## Features
## Any New Features?
Lo-Dash comes with AMD loader support, chainable `_.each`, lazy `_.bind`, [and more](https://github.com/bestiejs/lodash/wiki/The-Low-Down#wiki-features)...
Lo-Dash comes with AMD loader support, chainable [_.forEach](http://lodash.com/docs#_foreachcollection-callback--thisarg), lazy [_.bind](http://lodash.com/docs#_bindfunc--arg1-arg2-), [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.
Custom builds make it easy to create lightweight versions of Lo-Dash containing only the methods you need.
We handle all the method dependency and alias mapping for you.
Custom builds may be created in two ways:
@@ -117,8 +114,9 @@ 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">&#8617;</a>
* 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.
* Lo-Dash is part of the BestieJS *"Best in Class"* module collection. This means we promote solid browser/environment support, ES5 precedents, unit testing, and plenty of documentation.
## Author