Skip to content

Readme Revitalization #87

Open
Open
Readme Revitalization#87
Labels
documentationImprovements or additions to documentationenhancementNew feature or requesthelp wantedExtra attention is needed
@LCVcode

Description

@LCVcode
LCVcode
opened on Sep 18, 2024

Problem

README.md is out of date.

Proposed Feature

Make all below listed changes to README.md. I will update this list as needed.

Additional Context

With this issue, #12 becomes stale and will be removed.

Not-necessarily-comprehensive list of required changes:

  • Example commands - similar to those from juju-jockey info (include dot notation and how to use @)
  • Development setup tutorial (poetry install and poetry shell)
  • Installation tutorial (via snap and/or others)
  • Documentation and tutorials/examples for all remote Juju options
  • Tutorial for viewing the docs locally

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requesthelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions