Create README.md

philippdormann · Feb 7, 2022 · ab786d7 · ab786d7
1 parent becded1
commit ab786d7
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md 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("[email protected]"));
+// true
+console.log(isTempMail("[email protected]"));
+// false
+```