diff --git a/README.md b/README.md index 8e0d9d7..3128fe5 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,20 @@ String validator for more. ## Usage -### Node.js - ``` var validator = require('is-valid'); + +validator.isEmail('abc@gmail.com'); // => true ``` +### Validators + +- isEmail(str): check if it is an Email string +- isAllChinese(str): check if it is a string only contains Chinese characters +- isAllEnglish(str): check if it is a string only contains English characters +- isAllDigit(str): check if it is a string only contains digits +- isChineseTel(str): check if it is a Chinese cell-phone number + ## License The MIT License