Update README.md

[kevwhitt-hee]

PR Template

TODO:

Test it here too
https://technologyenhancedlearning.github.io/GitPageBlazorWASM-TestGHPage/
check version matches branch name and pullrequest release

• maybe a rule that any introduced css for example if bringing in an enum. needs to be refactored to nhse-tel? so tel-nhse is source of truth on all things css

TODO: About

• SO FAR no js controllers are not going to be covered in testing in the package it will be done by how used in LH
  But in future we could simulate them with just an api with stock response or find a programatic way, or build a hosted environment.
  The gh-page are pure wasm so not supported for nojs

• brave check no js (Locally not on wasm static test page)

TODO: This is just replicating LH for now ... ideas

• Link to replicated component
• Link design confluence if coming from design
• Tick box for JS
• If testers find an issue create an automated test of what they did, even potentially with playright record test functionality
• something about is there a linked lh branch using the change

JIRA link

TD-5671

Description

Updates the readme to include:

• improved project overview
• features list
• zero-to-hero/quick start section
• licence information
• contribution information
• tidier existing content

Screenshots

N/A

---

Developer checks

(Leave tasks unticked if they haven't been appropriate for your ticket.)

I have:

• Run the IDE auto formatter on all files I’ve worked on and made sure there are no IDE errors relating to them
• Written or updated tests for the changes (accessibility ui tests for views, tests for controller, data services, services, view models created or modified) and made sure all tests are passing
• Manually tested my work with and without JavaScript (adding notes where functionality requires JavaScript)
• Tested any Views or partials created or changed with Wave Chrome plugin. Addressed any valid accessibility issues and documented any invalid errors
• Updated my Jira ticket with testing notes, including information about other parts of the system that were touched as part of the MR and need to be tested to ensure nothing is broken
• Scanned over my pull request in GitHub and addressed any warnings from the GitHub Build and Test checks in the GitHub PR ‘Files Changed’ tab
  Either:
• Documented my work in Confluence, updating any business rules applied or modified. Updated GitHub readme/documentation for the repository if appropriate. List of documentation links added/changed:
  • doc_1_here
    Or:
• Confirmed that none of the work that I have undertaken requires any updates to documentation

[kevwhitt-hee]

@Phil-NHS, I am seeing failed checks above. Not sure I've changed anything that would cause these?

We need to add a MIT licence to the project if we haven't already.

We could do with shortening the instructions - they read more like a user manual than a readme. I will try to do this, but it is going to be time-consuming. I've put some quick start stuff in to try to help and added this draft PR so you can see what I've done so far. Please, let me know what you think?

[Phil-NHS]

@kevwhitt-hee

You are quite right about the licence.

It does read like a user manual i dont really know how to do it well but i did want by the end for it to be understood so maybe i was doing two objectives, i felt in the lh one there wernt enough "checking it works so far moments"
so i wanted to keep checking it works

quick start is a good idea

The fail is because of the commit name to get around it you would need squash and name it something like

docs(readme): improving setup instructions
like this repo commitlint rules

the commit names are used to calculate the version number so its not just a good practice thing

[Phil-NHS]

Client side hosted is how we will host it in LH. and we will host it client side hosted, or client side prerender, im not sure the most correct term.

the "hosted" or "prerendered" means they get serverside static blazor first while it loads the wasm, this is supposed to be so you dont see the loader but we will use the static html as our nojs fallback, because with nojs the second stage, the hydration with wasm never happens.

the package itself could be used server, static, ssr i think thats serverside stream or something, auto which is the components having individual rules on how they are rendered. in lh itself we could even have blazor pages servered one way components another.

also i think we could potentially use the library in native apps if we wanted

[kevwhitt-hee]

@Phil-NHS, I'm going to leave this in draft until you've got what you need from it. Then feel free to close it. I will start a new branch for changes to the setup instructions when I work through them again.