diff --git a/README.md b/README.md new file mode 100644 index 0000000..a62f453 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# tempmail-detect +node module to detect temporary email addresses known for spam + +## Installation +```sh +yarn add tempmail-detect +``` + +## Usage +```js +import { isTempMail } from "tempmail-detect"; + +console.log(isTempMail("spam@host1s.com")); +// true +console.log(isTempMail("good@email.com")); +// false +```