REFACTOR: fixed imports and changed README

Author: Alisher Aripov

README.md

@@ -4,7 +4,7 @@ Fully typed form validation hooks for vue 3.
 ## Installation
 
 ```shell
-npm install vue3-validation
+npm i -S light-vue3-validation
 ```
 
 ## Usage
@@ -125,20 +125,37 @@ reactive({
 </script>
 ```
 
+**If some filed in your object not need validation just write an empty array in rules `{ model: '', rules: [] }`**
+
 ### Also, you can use it without typescript, just don't write a types
 _Errors object in `useValidate` hooks will be soon_
 
 ## `useValidate` retrun
 Key | Value
 --- | ---
-model | Generic `<T>` 
-isValid | `boolean`
-modelRules | An object with key of validation keyword `required, numeric etc...` and value of `boolean`
+`model` | Generic `<T>` 
+`isValid` | `boolean`
+`modelRules` | An object with key of validation keyword `required, numeric etc...` and value of `boolean`
 
 ## `useValidateObject` return
 key | Value
 --- | ---
 Keys of your object | Keys wrapped by `useValidate` hook ` key: { model: ..., isValid: ..., modelRules: { ... } } `
-__isValid | `boolean`. Returns `true` if all `isValid` keys of your object items becomes `true`
-__clean | Returns `computed` **clean object** that you passed to hook with no wrapping by `useValidate` hook for each key
+`__isValid` | `boolean`. Returns `true` if all `isValid` keys of your object items becomes `true`
+`__clean` | Returns `computed` **clean object** that you passed to hook with no wrapping by `useValidate` hook for each key
+
+## Rules
+Rule name | Properties
+--- | ---
+`alpha` | Accepts only alphabetic characters (a-z and A-Z). Numbers will be failed
+`alphaNum` | Accepts only alphabetic and numeric characters (a-z A-Z 0-9)
+`between` | Accepts an array of range that your number will be. Example `[10, 30]`. Your number will be valid if it in this range
+`email` | Accepts a string which is email
+`ipAddress` | Accepts a string like `###.###.###.###`
+`maxLength` | Accepts a string which length is less then max value you passed
+`minLength` | Accepts a string which length is more then min value you passed
+`maxValue` | Accepts a number which is less then max value you passed
+`minValue` | Accepts a number which is more then min value you passed
+`numeric` | Accepts only number 0-9
+`required` | Accepts anything and will be failed if model is empty
 

coverage/clover.xml

@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<coverage generated="1670082918688" clover="3.2.0">
-  <project timestamp="1670082918688" name="All files">
-    <metrics statements="147" coveredstatements="76" conditionals="12" coveredconditionals="12" methods="13" coveredmethods="11" elements="172" coveredelements="99" complexity="0" loc="147" ncloc="147" packages="1" files="1" classes="1"/>
-    <file name="validators.ts" path="/Users/alisheraripov/Documents/work/libs/light-vue3-validation/dist/validators.ts">
-      <metrics statements="147" coveredstatements="76" conditionals="12" coveredconditionals="12" methods="13" coveredmethods="11"/>
+<coverage generated="1670389796484" clover="3.2.0">
+  <project timestamp="1670389796484" name="All files">
+    <metrics statements="151" coveredstatements="78" conditionals="12" coveredconditionals="12" methods="13" coveredmethods="11" elements="176" coveredelements="101" complexity="0" loc="151" ncloc="151" packages="1" files="1" classes="1"/>
+    <file name="index.ts" path="/Users/alisheraripov/Documents/work/libs/light-vue3-validation/dist/index.ts">
+      <metrics statements="151" coveredstatements="78" conditionals="12" coveredconditionals="12" methods="13" coveredmethods="11"/>
       <line num="1" count="1" type="stmt"/>
       <line num="2" count="1" type="stmt"/>
       <line num="3" count="1" type="stmt"/>
@@ -151,6 +151,10 @@
       <line num="145" count="0" type="stmt"/>
       <line num="146" count="0" type="stmt"/>
       <line num="147" count="0" type="stmt"/>
+      <line num="148" count="0" type="stmt"/>
+      <line num="149" count="0" type="stmt"/>
+      <line num="150" count="1" type="stmt"/>
+      <line num="151" count="1" type="stmt"/>
     </file>
   </project>
 </coverage>

coverage/coverage-final.json

@@ -23,9 +23,9 @@ <h1>All files</h1>
         <div class='clearfix'>
 
             <div class='fl pad1y space-right2'>
-                <span class="strong">51.7% </span>
+                <span class="strong">51.65% </span>
                 <span class="quiet">Statements</span>
-                <span class='fraction'>76/147</span>
+                <span class='fraction'>78/151</span>
             </div>
 
 
@@ -44,9 +44,9 @@ <h1>All files</h1>
 
 
             <div class='fl pad1y space-right2'>
-                <span class="strong">51.7% </span>
+                <span class="strong">51.65% </span>
                 <span class="quiet">Lines</span>
-                <span class='fraction'>76/147</span>
+                <span class='fraction'>78/151</span>
             </div>
 
 
@@ -79,18 +79,18 @@ <h1>All files</h1>
 </tr>
 </thead>
 <tbody><tr>
-	<td class="file medium" data-value="validators.ts"><a href="validators.ts.html">validators.ts</a></td>
-	<td data-value="51.7" class="pic medium">
+	<td class="file medium" data-value="index.ts"><a href="index.ts.html">index.ts</a></td>
+	<td data-value="51.65" class="pic medium">
 	<div class="chart"><div class="cover-fill" style="width: 51%"></div><div class="cover-empty" style="width: 49%"></div></div>
 	</td>
-	<td data-value="51.7" class="pct medium">51.7%</td>
-	<td data-value="147" class="abs medium">76/147</td>
+	<td data-value="51.65" class="pct medium">51.65%</td>
+	<td data-value="151" class="abs medium">78/151</td>
 	<td data-value="100" class="pct high">100%</td>
 	<td data-value="12" class="abs high">12/12</td>
 	<td data-value="84.61" class="pct high">84.61%</td>
 	<td data-value="13" class="abs high">11/13</td>
-	<td data-value="51.7" class="pct medium">51.7%</td>
-	<td data-value="147" class="abs medium">76/147</td>
+	<td data-value="51.65" class="pct medium">51.65%</td>
+	<td data-value="151" class="abs medium">78/151</td>
 	</tr>
 
 </tbody>
@@ -101,7 +101,7 @@ <h1>All files</h1>
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2022-12-03T15:55:18.679Z
+                at 2022-12-07T05:09:56.475Z
             </div>
         <script src="prettify.js"></script>
         <script>