knockout-validator

Add a description here...

Installation

npm

npm i -S knockout-validator

other

Browser, amd, commonjs, umd, systemjs and es6 versions of this module are available on the Github Releases.

Usage

TODO

Documentation

TODO

Building

In order to build knockout-validator, ensure that you have Git and Node.js installed.

Clone a copy of the repo:

git clone https://github.com/flut1/knockout-validator.git

Change to the knockout-validator directory:

cd knockout-validator

Install dev dependencies:

npm install

Use one of the following main scripts:

npm run build   		# build this project
npm run generate   		# generate all artifacts (compiles ts, webpack, docs and coverage)
npm run typings			# install .d.ts dependencies (done on install)
npm run test-unit    	# run the unit tests
npm run validate		# runs validation scripts, including test, lint and coverage check
npm run lint			# run tslint on this project
npm run doc				# generate typedoc and yuidoc documentation
npm run typescript-npm	# just compile the typescript output used in the npm module

When installing this module, it adds a pre-commit hook, that runs the validate script before committing, so you can be sure that everything checks out.

Contribute

View CONTRIBUTING.md

Changelog

View CHANGELOG.md

Authors

View AUTHORS.md

LICENSE

MIT © Floris Bernard