add docs

README.md

@@ -39,6 +39,14 @@ import util from '@substrate-system/util'
 import { attributesToString } from '@substrate-system/util'
 ```
 
+### `parseForm`
+
+Serialize a form and return a plain object. If a form control with the same name appears more than once, the property will be converted to an array.
+
+```ts
+function parseForm (form:HTMLFormElement):Record<string, unknown>
+```
+
 ### `attributesToString` 
 
 Take an array of attributes, and transform them into a string format. This can be useful for creating [web components](https://developer.mozilla.org/en-US/docs/Web/API/Web_components).

src/index.ts

@@ -16,7 +16,7 @@ export function attributesToString (attrs:Attr[]):string {
  * If a form control with the same name appears more than once, the
  * property will be converted to an array.
  */
-export function formToObject (form:HTMLFormElement):Record<string, unknown> {
+export function parseForm (form:HTMLFormElement):Record<string, unknown> {
     const formData = new FormData(form)
     const object:Record<string, unknown> = {}
 

test/index.ts

@@ -4,7 +4,7 @@ import {
     attributesAsObject,
     objectToString,
     setAttributes,
-    formToObject
+    parseForm
 } from '../src/index.js'
 
 test('formToObject', t => {
@@ -14,7 +14,7 @@ test('formToObject', t => {
     </form>`
 
     const form = document.querySelector('form')!
-    const obj = formToObject(form)
+    const obj = parseForm(form)
     t.deepEqual(obj, {
         hello: 'world',
         testnull: ''