Update README.md

Author: kapilkashyap

README.md

@@ -1,5 +1,72 @@
-jQuery Filter JSON Changelog
+# jQuery Filter JSON
 
-Version 1.0
-==============================================
-- Initial release
+This jQuery plugin is a utility that allows you to filter a JSON based on properties. You can also have a property/value match and only those
+property values that match the passed in value will be returned.
+
+However, you can filter the JSON based on various parameters such as startWith or checkContains, matchCase and can either choose to return the 
+matched values or the parent object of the matched values. You even have the option of avoiding duplicates if any.
+
+Below is a basic usage:
+````javascript
+$.fn.filterJson({ json object }, {
+                        property: "name",
+                        wrapper: true,
+                        value: "user one",
+	                    checkContains: false,
+	                    startsWith: true,
+	                    matchCase: false,
+	                    avoidDuplicates: true
+                    });
+````
+# Plugin Properties Explained
+Before digging into each property of the plugin lets describe our sample JSON.
+````javascript
+{
+    {
+        "id": 12345,
+        "name": "User One",
+        "email": "[email protected]"
+    },{
+        "id": 23456,
+        "name": "User Two",
+        "email": "[email protected]"
+    },{
+        "id": 34567,
+        "name": "User Three",
+        "email": "[email protected]"
+    }
+    .
+    .
+    .
+}
+````
+
+* property (mandatory, default is null): This options takes the value of the property that you need to filter the JSON with. For the above sample JSON we can have three properties
+id, name and email.
+
+* wrapper (optional, default is false): If set to true, it will return an array of the parent object of the matched property else will return an array of value itself.
+For instance if we are filtering the above sample JSON with 'name' property and wrapper is set to true, then an array of all the Objects which 
+have the 'name'property will be returned.
+If the wrapper is set to false, then an array of only the values of the property will be returned. For the above sample JSON
+["User One", "User Two", "User Three"] would be returned.
+
+* value (optional, default is ""): An optional value passed to be matched with the value of the matched property value.
+
+* checkContains (optional, default is false): Setting this option to true will check if the matched property's value contains the passed in value. However, passing a value becomes mandatory for this to work.
+This option will be considered only if it is true and startsWith is not set to true.
+
+* startsWith (optional, default is false): Setting this option to true will check if the matched property's value starts with the passed in value. However, passing a value becomes mandatory for this to work.
+This options takes precedence over checkContains if it is set to true.
+
+* matchCase (optional, default is false): If set to true will perform case-sensitive search of values.
+
+* avoidDuplicates (optional, default is false): If set to true will avoid duplicate objects.
+
+# Known Issues
+
+For this plugin to work in IE7 and below, you will have to include JSON2
+
+# Licence
+
+Copyright (c) 2012 Kapil Kashyap.
+Dual licensed under MIT License and GPL License.