From 18fa8acdc3193dc1e03257c7cd9d6763611702a2 Mon Sep 17 00:00:00 2001 From: John-David Dalton Date: Sun, 22 Apr 2012 18:29:26 -0400 Subject: [PATCH] lodash: Update README.md and package.json. [jddalton] Former-commit-id: 1a52087987c12d73cba383e6ebe346af7bded150 --- README.md | 14 ++++++-------- package.json | 2 +- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e60065258..7d53282e5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Lo-Dash v0.1.0 -TBD +A drop-in replacement for [Underscore.js](https://github.com/documentcloud/underscore/) that delivers **up to 8x performance improvements**, bug fixes, and additional features. ## BestieJS @@ -9,6 +9,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) +Underscore's [documentation](http://documentcloud.github.com/underscore/) may also be used. For a list of upcoming features, check out our [roadmap](https://github.com/bestiejs/lodash/wiki/Roadmap). @@ -47,6 +48,9 @@ load('lodash.js'); In an AMD loader like [RequireJS](http://requirejs.org/): ~~~ js +// opt-in +define.amd.lodash = true; + require({ 'paths': { 'lodash': 'path/to/lodash' @@ -57,12 +61,6 @@ require({ }); ~~~ -Usage example: - -~~~ js -// TBD -~~~ - ## Cloning this repo To clone this repository including all submodules, using Git 1.6.5 or later: @@ -80,7 +78,7 @@ cd lodash git submodule update --init ~~~ -Feel free to fork if you see possible improvements! +Feel free to fork and send pull requests if you see possible improvements! ## Author diff --git a/package.json b/package.json index 660095338..42768ad24 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "lodash", "version": "0.1.0", - "description": "TBD", + "description": "A drop-in replacement for Underscore.js that delivers up to 8x performance improvements, bug fixes, and additional features.", "homepage": "https://github.com/bestiejs/lodash", "main": "lodash", "keywords": [