added license and documentation

Author: SenthilBalaji

LICENSE.md

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2016 KBLNY
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

readme.md

@@ -1,7 +1,52 @@
-## Developing a validation mechanism for node-express applications
+# express-input-validation
 
-Released version-1 still unstable and in development.
+![npm version](https://img.shields.io/npm/v/express-validator.svg)
 
-- one stable version is released for now.
-- refer example for how to use.
-- documentation coming soon.
+An [express.js]( https://github.com/visionmedia/express ) middleware for input validation.
+
+express-input-validation is simple yet powerful node module that makes your API robust and discard any request with invalid input.
+
+- [Installation](#installation)
+- [Features](#features)
+- [Examples](#examples)
+- [License](#license)
+
+## Installation
+```
+npm install express-input-validation
+```
+OR
+```
+yarn add express-input-validation
+```
+## Features
+you can ask `express-input-validation` to get value from any of these(following list) using `from` key in rules array, 
+
+- Header (header)
+- Query (query)
+- Body (body)
+- Params (param)
+
+and can pass any custom validation function using `validation_function` in the rules array. Also you can pass a `message` in rules for particular rule or it'll be default send a `invalid ${key_name}` as message.
+
+## Example
+Following are the example for validating using `express-input-validation`, here I have included all four type of inputs that most commonly an API can have:
+
+```
+    {
+        "from": "query",
+        "key": "emailId",
+        validation_function: value => value.indexOf("@") > -1
+    }
+```
+
+In rules array the above one can be one of the objects, here I've showed a custom `validation_function` without message, this ll return `Invalid emailId` incase the email id is not found or if it doesn't have an `@` in the value string.
+
+# Note
+- `key`, `from` are required keys in object in all of the rule you define.
+- a rule without a `validation_function` is considered to be only `required` field, i.e., `express-input-validation` only checks if there is a field in specified `from` key in the object.
+- for more examples
+
+## License
+
+MIT License