chore: update README for v3

[baseballyama]

⚠️ We need to merge this PR when we release v3.0.0

I’ve created the README from scratch, updating it mainly based on the ESLint settings generated by the sv create command.
Additionally, I’ve adjusted the style of the documentation site. Since it’s planned to be migrated to Svelte’s official site later, it should be fine unless there’s something significantly wrong.

MEMO

I need to handle #1043

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/eslint-plugin-svelte@1041

commit: 8eeedb5

[changeset-bot]

⚠️ No Changeset found

Latest commit: 9a88c50

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

[github-actions]

Try the Instant Preview in Online Playground

ESLint Online Playground

Install the Instant Preview to Your Local

npm i https://pkg.pr.new/eslint-plugin-svelte@1041

Published Instant Preview Packages:

• eslint-plugin-svelte: https://pkg.pr.new/eslint-plugin-svelte@1041

View Commit

[baseballyama]

I have completely rewritten the README. Could you check if there’s any missing information?

[baseballyama]

I’ve tidied up the site’s style. Please check if there are any design issues.

[ota-meshi]

It's great! Thank you!

[mikededo]

Should we also take the opportunity to update the CONTRIBUTING.md file? It was last modified nearly a year ago and there are some things which are not clear (i.e. the scripts section does not mention that such scripts should be executed from packages/eslint-plugin-svelte) or outdated (i.e. such as this script which does not exist).

[baseballyama]

Let’s do this in a separate PR. And contributions are welcome!
I will merge this PR this weekend after confirming that everything is ready to release v3.