docs: add usage examples of minDomainAtoms (#209)

skeggse · Oct 15, 2020 · 229def1 · 229def1
1 parent 1f134c5
commit 229def1
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -76,6 +76,12 @@ false
 65
 > Isemail.validate('test@', {errorLevel: true});
 131
+> Isemail.validate('test@iana', {minDomainAtoms: 1}); // default
+true
+> Isemail.validate('test@iana', {minDomainAtoms: 2});
+false
+> Isemail.validate('test@iana.io', {minDomainAtoms: 2});
+true
 ```
 
 <sup name="footnote-1">&#91;1&#93;</sup>: if this badge indicates the build is passing, then isemail has 100% code coverage.