diff --git a/README.md b/README.md index dde5dc0..19871f4 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,17 @@ -# formxtra - -![formxtra logo](./docs/assets/formxtra.svg) - -**The companion for Web forms!** - -Extract and set form values through the DOM. +
+

+ formxtra +

+

+ The companion for Web forms! +

+

+ Extract and set form values through the DOM—no frameworks required! +

+

+ Lightweight. Simple. It Just Works. +

+
## Installation @@ -89,6 +96,15 @@ autofillButton.addEventListener('click', e => { }); ``` +There are utility functions exported alongside `getFormValues()` and `setFormValues()`. You may want to use namespace +import with this library, i.e. `import * as formxtra from '@theoryofnekomata/formxtra'`. + +See the [documentation folder](./docs) for more details. + ## Tests The library has been tested on the static DOM using JSDOM, and the real dynamic DOM using Cypress. + +## License + +[MIT](./LICENSE) diff --git a/docs/assets/formxtra.svg b/docs/assets/formxtra.svg index a6f3c26..af4597e 100644 --- a/docs/assets/formxtra.svg +++ b/docs/assets/formxtra.svg @@ -1,38 +1,2 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +