Amended README and filled in meta information, also added travis-ci o…

…ptions

.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - "0.8"
+  - "0.9"
+  - "0.10"

README.md

@@ -1,4 +1,131 @@
 Asynchronous input filter
 =======================
 
-A high-level library for filtering (sanitisation) and validating input data
+[![Build Status](https://api.travis-ci.org/dVaffection/node-input-filter-async.png)](https://travis-ci.org/dVaffection/node-input-filter-async)
+
+A high-level library for filtering (sanitization) and validating input data
+
+## Installation
+
+     npm install input-filter-async
+
+## Usage
+
+#### Basic usage
+**NOTE:** 
+
+* if `required: true` is NOT specified, value is considered **optional** 
+* value is **pre filtered** regardless whether it's *mandatory* or *optional*, if value is not given `null` is placed instead
+* if value is **optional but given** then it's **validated**
+* finally if value **passed validation** then it's **post filtered**
+
+> Basic validation and sanitization is build upon [node-validator](https://github.com/chriso/node-validator) library by **Chris O'Hara**
+
+```javascript
+var InputFilter = require('input-filter-async');
+var rules = {
+    'name': {
+        'required': true,
+        'preFilters': [
+            'trim',
+        ],
+    },
+    'age': {
+        'required': false,  // also FALSE if absent
+        'preFilters': [
+            'trim',
+        ],
+        'validators': [
+            'isInt',
+        ],
+        'postFilters': [
+            'toInt',
+        ],
+    },
+};
+var data = {
+    name: " dV ",
+    age: ' 29 ',
+};
+
+var inputFilter = new InputFilter(rules);
+inputFilter.isValid(data, function(isValid) {
+    if (isValid) {
+        console.log(this.getValues());      // { name: 'dV', age: 29 }
+        console.log(this.getValue('age'));  // 29
+    } else {
+        console.log(this.getErrors());
+        /*
+        {
+            name: 'Value is required and can't be empty',
+            age: 'Invalid integer'
+        }
+         */
+    }
+});
+```
+
+#### Writing you own filters and validators.
+**NOTE:** 
+
+* filters work in **synchronous** way while validators are expected to be **asynchronous**
+
+```javascript
+var _ = require('underscore');
+var MongoClient = require('mongodb').MongoClient;
+MongoClient.connect('mongodb://127.0.0.1:27017/test', function(err, db) {
+    if (err)
+        throw err;
+
+    var usersCol = db.collection('users');
+    var InputFilter = require('input-filter-async');
+    var rules = {
+        name: {
+            required: true,
+            preFilters: [
+                'trim',
+                function(value) {
+                    if (_.isString(value)) {
+                        value = value.toLowerCase();
+                    }
+
+                    return value;
+                },
+            ],
+            validators: [
+                function(value, params, callback) {
+                    // params — passed data
+
+                    var query = {name: value};
+                    usersCol.findOne(query, function(err, doc) {
+                        if (err)
+                            throw err;
+
+                        if (doc) {
+                            var message = 'User "' + value + '" already exists';
+                            callback(message);
+                        } else {
+                            callback(null);
+                        }
+                    });
+                },
+            ],
+        },
+    };
+    var data = {
+        name: " JOHN SMITH ",
+    };
+
+    var inputFilter = new InputFilter(rules);
+    inputFilter.isValid(data, function(isValid) {
+        if (isValid) {
+            // { name: 'john smith' }
+            console.log(this.getValues());
+        } else {
+            // { name: 'User "john smith" already exists' }
+            console.log(this.getErrors());
+        }
+    });
+});
+
+```

package.json

@@ -1,7 +1,6 @@
 {
     "name": "input-filter-async",
-    "_id": "input-filter-async@1.0.0",
-    "version": "1.0.0",
+    "version": "0.0.0",
     "description": "A high-level library for filtering (sanitisation) and validating input data",
     "keywords": [
         "validator",
@@ -36,6 +35,9 @@
         "url": "git://github.com/dVaffection/node-input-filter-async.git"
     },
     "scripts": {
-        "test": "nodeunit tests"
+        "test": "./node_modules/nodeunit/bin/nodeunit tests"
+    },
+    "engines": {
+        "node": ">=0.2.2"
     }
-}
+}