diff --git a/.idea/sonarlint/issuestore/1/d/1d784fce58c3719506730fb9749600554125b511 b/.idea/sonarlint/issuestore/1/d/1d784fce58c3719506730fb9749600554125b511
deleted file mode 100644
index e69de29..0000000
diff --git a/.idea/sonarlint/issuestore/index.pb b/.idea/sonarlint/issuestore/index.pb
index b62cda3..33e91a7 100644
--- a/.idea/sonarlint/issuestore/index.pb
+++ b/.idea/sonarlint/issuestore/index.pb
@@ -17,8 +17,6 @@ P
src/test/java/ValidatorTest.java,5\8\588b78f1e6cd56164975813197d21c04f270e038
G
multiform-validator.iml,d\5\d504f9b2cf453f919611cab68c0658cce3d4302e
-<
-settings.xml,1\d\1d784fce58c3719506730fb9749600554125b511
S
#.github/workflows/maven-publish.yml,8\5\85f48f2e34e9dcd0e1756f077d1409251f006845
9
diff --git a/.idea/sonarlint/securityhotspotstore/1/d/1d784fce58c3719506730fb9749600554125b511 b/.idea/sonarlint/securityhotspotstore/1/d/1d784fce58c3719506730fb9749600554125b511
deleted file mode 100644
index e69de29..0000000
diff --git a/.idea/sonarlint/securityhotspotstore/index.pb b/.idea/sonarlint/securityhotspotstore/index.pb
index b62cda3..33e91a7 100644
--- a/.idea/sonarlint/securityhotspotstore/index.pb
+++ b/.idea/sonarlint/securityhotspotstore/index.pb
@@ -17,8 +17,6 @@ P
src/test/java/ValidatorTest.java,5\8\588b78f1e6cd56164975813197d21c04f270e038
G
multiform-validator.iml,d\5\d504f9b2cf453f919611cab68c0658cce3d4302e
-<
-settings.xml,1\d\1d784fce58c3719506730fb9749600554125b511
S
#.github/workflows/maven-publish.yml,8\5\85f48f2e34e9dcd0e1756f077d1409251f006845
9
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 639b776..145d885 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -4,7 +4,13 @@
-
+
+
+
+
+
+
+
diff --git a/README.md b/README.md
index 6b3e1e9..d93f200 100644
--- a/README.md
+++ b/README.md
@@ -5,8 +5,32 @@
## JAVA
-How to use:
+## How to install
follow the steps below to use the library in your project.
-https://jitpack.io/#multiform-validator/java/0.0.1
\ No newline at end of file
+https://jitpack.io/#multiform-validator/java/0.0.1
+
+## Example of how to use
+
+```java
+import io.github.multiform_validator.Validator;
+import io.github.multiform_validator.EmailValidator;
+import io.github.multiform_validator.CpfValidator;
+import io.github.multiform_validator.CnpjValidator;
+
+public class Main {
+ public static void main(String[] args) {
+ System.out.println(emailValidator.isEmail("foo@bar.com")); // true
+ System.out.println(emailValidator.isEmail("foo@bar")); // false
+
+ System.out.println(cpfValidator.cpfIsValid("123.456.789-09")); // true
+ System.out.println(cpfValidator.cpfIsValid("123.456.789-00")); // false
+
+ System.out.println(cnpjValidator.cnpjIsValid("12.345.678/0001-09")); // true
+ System.out.println(cnpjValidator.cnpjIsValid("12.345.678/0001-00")); // false
+ }
+}
+```
+
+Lib is in development, there's other validators that you can use, but they are not yet documented.
\ No newline at end of file