docs: improve readme

[jcbhmr]

closes #6

This doesn't remove the under construction banner (since we don't have anything to show for this repo yet), but it does add some badly needed content to the readme!

[eitsupi]

We should merge #23 first.

[github-actions]

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
✅ COPYPASTE	jscpd	yes		no	1.42s
✅ EDITORCONFIG	editorconfig-checker	1		0	0.02s
✅ MARKDOWN	markdownlint	1	0	0	0.55s
✅ MARKDOWN	markdown-link-check	1		0	1.13s
✅ MARKDOWN	markdown-table-formatter	1	0	0	0.25s
✅ REPOSITORY	checkov	yes		no	9.74s
✅ REPOSITORY	devskim	yes		no	0.63s
✅ REPOSITORY	dustilock	yes		no	0.25s
✅ REPOSITORY	gitleaks	yes		no	0.24s
✅ REPOSITORY	git_diff	yes		no	0.0s
✅ REPOSITORY	kics	yes		no	13.04s
✅ REPOSITORY	secretlint	yes		no	0.7s
✅ REPOSITORY	syft	yes		no	0.31s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by

[eitsupi]

Thanks for updates.
Could you fix points the linter pointed out?

[jcbhmr]

Yep! I won't make the mistake of ignoring the linter again 😆

[jcbhmr]

This PR is currently BLOCKED by the website link being a 404. This PR should not be merged until the website exists.

[jcbhmr]

I've added some MarkdownLint disable comments:

<!-- markdownlint-disable MD041 MD033 -->

Why?

• MD041: allow image to be first; the rule requires the first line be # Heading
• MD033: allow inline HTML for centered image; the rule disallows HTML

[eitsupi]

• MD033: allow inline HTML for centered image; the rule disallows HTML

Note that only certain tags can be allowed.
https://github.com/rocker-org/rocker-versioned2/blob/30f354ba627c0148581426abd588b1e770802570/.markdownlint.yaml#L12-L13

[eitsupi]

@jcbhmr Could you take a look at this?

[eitsupi]

Would you like to review the Linter settings as I commented above?

[eitsupi]

@jcbhmr Do you still plan to work on this project?