komvvm/README.md

Knockout MVVM Extensions to help Knockout app development

# KoMvvm
[![Build Status](https://travis-ci.org/spatools/komvvm.png)](https://travis-ci.org/spatools/komvvm) [![Bower version](https://badge.fury.io/bo/komvvm.png)](http://badge.fury.io/bo/komvvm) [![NuGet version](https://badge.fury.io/nu/komvvm.png)](http://badge.fury.io/nu/komvvm)

Knockout Utilities Extensions to simplify Knockout app development using MVVM Pattern.

## Installation

Using Bower:

```console
$ bower install komvvm --save
```

Using NuGet: 

```console
$ Install-Package KoMvvm
```

## Usage

You could use komvvm in different context.

### Browser (AMD from source)

#### Configure RequireJS.

```javascript
requirejs.config({
    paths: {
        knockout: 'path/to/knockout',
        koutils: 'path/to/koutils',
        komvvm: 'path/to/komvvm'
    }
});
```

#### Load modules

```javascript
define(["komvvm/commands"], function(commands) {
    var command = new commands.AsynCommand({
        canExecute: function(isExecuting) { return !isExecuting && /* ... */; },
        execute: function(complete) { 
            // ...
            complete();
        }
    });
});
```

### Browser (with built file)

Include built script in your HTML file.

```html
<script type="text/javascript" src="path/to/knockout.js"></script>
<script type="text/javascript" src="path/to/koutils.min.js"></script>
<script type="text/javascript" src="path/to/komvvm.min.js"></script>
```

## Documentation

Documentation is hosted on [Github Wiki](https://github.com/spatools/komvvm/wiki).

## Release History
0.1.0 Initial release
0.1.1 Fix issue in unsubscribe method when giving a callback which is not subscribed
0.1.2 Update typescript to version 1.1
0.1.3 
    * Update KoUtils to 1.0.1
    * Remove underscore.js references
    * Update typescript to version 1.4