Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Readme Revitalization #87

Open
5 tasks
LCVcode opened this issue Sep 18, 2024 · 0 comments
Open
5 tasks

Readme Revitalization #87

LCVcode opened this issue Sep 18, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@LCVcode
Copy link
Owner

LCVcode commented Sep 18, 2024 •
edited
Loading

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
@LCVcode LCVcode added enhancement New feature or request documentation Improvements or additions to documentation help wanted Extra attention is needed labels Sep 18, 2024
@LCVcode LCVcode mentioned this issue Sep 18, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@LCVcode