feat: updated readme

vigneshkb7 · Jun 24, 2023 · 430c4f9 · 430c4f9
1 parent e713794
commit 430c4f9
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,31 @@
 # card-validator-utils
+
 Library package util for payment industry
+
+## installation
+
+```
+npm i card-validatore-utils
+```
+
+## usage
+
+`isCreditCard` function return boolean
+
+```
+const { isCreditCard } = require("card-validator-utils");
+
+isCreditCard('4242424242424242')
+
+```
+
+`isEncryptedToken` function returns boolean based 44 digit input
+
+44 digit is encrypted version of card number
+
+```
+const { isEncryptedToken } = require("card-validator-utils");
+
+isEncryptedToken('42424242F242R24242424242F24242424242424C424X')
+
+```