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.