README

Author: ish-101

README.md

@@ -1,14 +1,18 @@
 # HTML Input Type SerialNumber
 A new type of HTML Input field which is specially built for Serial Numbers. It assists the user while filling out the input field LIVE.
+
 ## _LIVE_ Pattern Matching and Auto Completion
+
 ### Pattern Matching
 It test for the Regular Expression separately on separate pieces of the input, instead of all at once. The invalid characters __automatically get deleted__.
+
 ### Auto Completion
 Some Serial Numbers have separating characters, such as dashes, between the pieces. This input field __automatically adds__ those separators wherever required.
 
 Since both these features LIVE, this software __assists__ the user while filling out the Serial Number, instead of simply pointing out that it was wrong.
+
 ## DEMO
-<input type=serialnumber>
+
 ## Installation
 1. Link jQuery version 3.x.x to the head of the page (if not already linked)
 ```html
@@ -59,7 +63,23 @@ Since both these features LIVE, this software __assists__ the user while filling
 	});
 </script>
 ```
-4. Use the input type "serialnumber" anywhere in the page to test if it works.
+4. Use the input type `serialnumber` anywhere in the page to test if it works.
 ```html
 <input type="serialnumber">
-```
+```
+
+## Configuration
+__`separator:`__ This property can be defined for the whole input box in general, or specially for each separator. Specific definitions override the general ones. (Default value is an empty string `""`)
+__`pieces:`__ This is an array of the __`piece`__ objects.
+-------__`length:`__ A positive integer denoting the number of character in a piece. (Default value is `1`)
+-------__`pattern:`__ A [Regular Expression](https://www.w3schools.com/jsref/jsref_obj_regexp.asp) which defines the allowed characters in a piece.
+-------__`type:`__ Should be set to `separator` to add a separator, or else, should be left blank. 
+
+## Information
+Made as a plugin for jQuery
+Dependent on jQuery version 3.x.x
+
+## Creator
+__Made By:__ _Ishpreet Singh Bhasin_
+[__Website__](http://ishpreet.tech/)
+[__GitHub__](https://github.com/ish-101/)

src/jquery.serialnumber.js

@@ -1,9 +1,11 @@
 /*
   HTML Input Type SerialNumber
-  by Ishpreet Singh Bhasin (ish-101)
   GitHub: https://github.com/ish-101/HTML-Input-Type-SerialNumber
-
   Dependency: jQuery 3.x.x
+  License:  GNU GENERAL PUBLIC LICENSE Version 3
+
+  Made by Ishpreet Singh Bhasin (ish-101)
+  Website: http://ishpreet.tech/
 */
 
 (function($)