From ab786d7b7126dcb0bb40a914ff0cfe26ac3c789d Mon Sep 17 00:00:00 2001
From: Philipp Dormann <17651032+philippdormann@users.noreply.github.com>
Date: Mon, 7 Feb 2022 22:05:58 +0100
Subject: [PATCH] Create README.md

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

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
+```