diff --git a/README.md b/README.md index 5cf8e8d..7926b49 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ +![Made to be Plundered](https://img.shields.io/badge/Made%20to%20be%20Plundered-royalblue) +[![Latest version](https://img.shields.io/github/v/release/PaulioRandall/p17)](https://github.com/PaulioRandall/p17/releases) +[![Release date](https://img.shields.io/github/release-date/PaulioRandall/p17)](https://github.com/PaulioRandall/p17/releases) + # P17 -Svelte library experimenting with form behaviour and user interaction (layout and style uses UK GDS as a guide). +P17 is a simple Svelte library for crafting forms. I crafted it to demonstrate my understanding and ability in accessible HTML form design and development. + +> I haven't really tested the accessibility aspect yet. + +I used the [GDS Design System](https://design-system.service.gov.uk/) as a loose guide because it helps to have a starting point; empirically backed double so. + +My library's unique selling point is that the field unvalidates when a user focuses on an input after validation has accepted or reject the current content (JavaScript only). It's not perfect. The unvalidation simply removes the error message which means users won't have it as reference as they're typing a new answer. + +> Maybe I'll improve that in a future version. No garuntees. + +## Made to be Plundered + +This library is made to be forked or plundered by anyone for whatever you want as long as you adhere to the permissive MIT license. If you think you can make it twice as good fork the repo and do it; steal snippets or concepts; copy the whole thing and modify to complete a two week job in two days then sit back and play games until hand in. Whatever, just break the rules and innovate! + +## Documentation + +> TODO: I need to build a simple documentation tool first. diff --git a/package-lock.json b/package-lock.json index cc32392..4e8425d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "p17", - "version": "0.5.1", + "version": "0.5.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "p17", - "version": "0.5.1", + "version": "0.5.2", "license": "MIT", "devDependencies": { "@sveltejs/adapter-auto": "3.2.0", diff --git a/package.json b/package.json index 4a85a8b..e196b53 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "description": "Svelte library experimenting with form behaviour and user interaction (layout and style uses UK GDS as a guide)", "type": "module", "license": "MIT", - "version": "0.5.1", + "version": "0.5.2", "engines": { "node": ">=18" },