Updated README.md

[thomasbuilds]

This PR significantly enhances the README by correcting all spelling and code errors, aligning its style with the SolidStart README through consistent use of badges, a core features section, and a concise, impactful introduction. The code snippets have been formatted using Prettier too.

Note: Should the full documentation reside in the README, or should users be redirected to a separate docs site, as done in the SolidStart repository? This PR does not remove any documentation, but this needs further discussion.

[changeset-bot]

⚠️ No Changeset found

Latest commit: d4a3f47

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[thomasbuilds]

PS: docs.solidjs.com/solid-router should be added as the website in repo settings

[ryansolid]

Thank you