Skip to content

docs: add install, quick start, commands, and more to readme - #90

Merged
beeme1mr merged 1 commit into
mainfrom
update-readme
Mar 28, 2025
Merged

beeme1mr merged 1 commit into
mainfrom
update-readme

Conversation

@beeme1mr

Copy link
Copy Markdown
Member

This PR

  • overhauls the readme to include:
    • Install Instructions
    • Quick start
    • Commands
    • Manifest/config overview
  • move design info to a dedicated file

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>

@kriscoleman kriscoleman left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

I appreciate the clear documentation and installation methods.

@beeme1mr
beeme1mr merged commit 9244276 into main Mar 28, 2025
@beeme1mr beeme1mr mentioned this pull request Apr 5, 2025
This was referenced Feb 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants