Add sweet nothings to the README

This commit is contained in:
Jared Hirsch 2015-08-12 19:00:26 -07:00
Родитель 392bf3fd57
Коммит cd428f85b7
1 изменённых файлов: 43 добавлений и 0 удалений

Просмотреть файл

@ -1,2 +1,45 @@
# micro-email-validator
Transliteration of html5 email validator in Firefox
## What is it?
From teh codez:
```
// Function to validate an email address.
// This is a transliteration of the HTML5 email-validation logic
// inside Firefox. It splits the username and domain portions,
// translates tham into IDN punycode syntax, then does some very
// basic sanity-checking.
```
## How to use it?
```
var validate = require('micro-email-validator');
validate('user@example.com'); // returns true
validate('foo@foo@foo'); // returns false
validate('例子@example.com'); // returns true, yay
```
Please note, however, that these rules are more liberal than you might think:
```
validate('wow_such@unsatisfy'); // returns true
validate('wat@'); // returns true
```
Have fun!
## License
MPL 2.0
## Brought to you by
The [fine minds](https://github.com/mozilla/fxa-auth-server/graphs/contributors)
behind Firefox Accounts, and [your humble narrator](https://github.com/6a68).