From c0d6405873f38753c9e7b72d596c1d608ef617b1 Mon Sep 17 00:00:00 2001
From: TheoryOfNekomata <allan.crisostomo@outlook.com>
Date: Mon, 10 May 2021 21:17:05 +0800
Subject: [PATCH] Add README

Include short details on using the library.
---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1fb3ff5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# get-form-values
+
+Get the value of a form using `HTMLFormElement.elements`.
+
+## Usage
+
+```typescript
+import getFormValues from '@theoryofnekomata/get-form-values';
+
+const form = document.getElementById('form')
+
+// optional, but just in case there are multiple submit buttons in the form,
+// individual submitters can be considered
+const submitter = form.querySelector('[type="submit"]')
+
+const values = getFormValues(form, submitter)
+```
+
+## Tests
+
+The library has been tested on JSDOM through Jest, and the real DOM using
+Cypress.