Skip to content

Commit

Permalink
Wriet README
Browse files Browse the repository at this point in the history
  • Loading branch information
PaulioRandall committed Apr 18, 2024
1 parent ef3b485 commit ce13f69
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 4 deletions.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down

0 comments on commit ce13f69

Please sign in to comment.