First pass at README changes

[SeanNaren]

Before submitting

TODO:

1. Let's get a logo for the repo like lightning: https://github.com/PyTorchLightning/pytorch-lightning/blob/master/docs/source/_static/images/logo.png
2. Add the eco system badges somewhere
3. Validate commands all work

• Was this discussed/approved via a GitHub issue? (no need for typos and docs improvements)
• Did you create/update your configuration file?
• Did you add your config to CI - GitHub action and Azure pipeline?
• Are all integration tests passing?

What does this PR do? [optional]

Fixes # (issue).

Did you have fun?

Make sure you had fun coding 🙃

[tchaton]

@SeanNaren any updates on the logo ?

[Borda]

@SeanNaren fyi, #10 is adding several discussed features 🐰

[Borda]

LGTM after #6 (comment)

[SeanNaren]

Should be good to go @Borda I'd add a minimal template.yaml with things commented out that are unnecessary for a normal repo.

[awaelchli]

Looks interesting!

[awaelchli]

We discovered that this won't do anything special unless the user is actually part of the repo (with write access).

[Borda]

true, but they are at least automatically added for the review..

[awaelchli]

No they are not, that's what I'm saying. See example here:
PR Lightning-AI/pytorch-lightning#10369
Codeowners: https://github.com/PyTorchLightning/pytorch-lightning/blob/85d7c4dce4661ef5c12fcbd0d9e164ffc371e1af/.github/CODEOWNERS#L28-L30

From
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners:

The people you choose as code owners must have write permissions for the repository. When the code owner is a team, that team must be visible and it must have write permissions, even if all the individual members of the team already have write permissions directly, through organization membership, or through another team membership.

[Borda]

I see, co we would need to come with another solution... :/