Context
Right now the README looks a bit more stale. We should enrich it in the future with more links to upstream docs, once we have them and/or more sections so that users can have a better first experience and be able to:
- Understand what the repo is about
- How they can get started
- What the charm is doing
What needs to get done
- Evaluate a small plan on what sections to include in the README
- I.e. should we include links to our specs?
- What other standard sections should our READMEs have?
- Link with upstream docs to point users to more details on how to use the charm
Definition of Done
- The README has more context on what the charm repo is, and how users can use it
Context
Right now the README looks a bit more stale. We should enrich it in the future with more links to upstream docs, once we have them and/or more sections so that users can have a better first experience and be able to:
What needs to get done
Definition of Done