Skip to content

Commit

Permalink
Enhanced readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kamranayub committed Mar 13, 2012
1 parent 4c669df commit 55c3177
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## [Underscore.js](http://documentcloud.github.com/underscore/) + [Knockout](http://knockoutjs.com) = Array Happy Fun Time! ##

This tiny library adds all the collection and array methods you've come to love in Underscore.js to your Knockout observable arrays. It will not override any existing functionality (if any exists).
This tiny library (< 1KB) adds all the collection and array methods you've come to love in Underscore.js to your Knockout observable arrays. It will not override any existing functionality (if any exists).

## Install ##

Expand All @@ -12,7 +12,9 @@ Download `underscore-ko.min.js` and put it in your project.

### Nuget ###

Install the UnderscoreKO Nuget package.
Install the [UnderscoreKO](http://nuget.org/packages/UnderscoreKO) Nuget package.

PM> Install-Package UnderscoreKO

## Usage ##

Expand Down Expand Up @@ -41,17 +43,17 @@ vm.arr.without_(2);
// Without this, you would need to do:
vm.arr(vm.arr.without(2));
```
#### Full Example ####
## Live Demo ##

View the [live jsFiddle demo](http://jsfiddle.net/kamranayub/exnqe/)

<iframe style="width: 100%; height: 300px" src="http://jsfiddle.net/kamranayub/exnqe/embedded/" allowfullscreen="allowfullscreen" frameborder="0"></iframe>
## Documentation ##

See the [Underscore.js](http://documentcloud.github.com/underscore/) documentation for more information on the API.
See the [Underscore.js](http://documentcloud.github.com/underscore/) documentation for more information on the API. All array and collection methods are supported with the exception of any I felt didn't provide value (`.toArray()` for example).

See `spec.js` for examples of how to use specific functions, but I'm telling you, it's as you'd expect.

#### Mutator Methods ####
### Mutator Methods ###

* `filter_`, `select_`
* `reject_`
Expand Down

0 comments on commit 55c3177

Please sign in to comment.