-
Notifications
You must be signed in to change notification settings - Fork 171
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.
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
Update readme content #672
Conversation
Still need to do copy edits and finalization but this should provide a better structure. |
Love all the badges and how much simpler/cleaner this is overall. I do want to fiddle with the wording a bit more in the first section. Feel like we do need a bullet point list of what zarf does / what it's major features are. Also the supported OS link seems to be dead. Would like to get a "build passing" badge too, but think we'd need to have an actual k3s test run on master for that to work. We do it on release right now. Lastly, we desperately need to update the demo to something more up to date, i can try to do that this week. |
See #632 for some ideas we can look at adding for the bullet point list. |
Will take a stab at updating that text. Where do you see the release action output? I only see where we build and push the release packages not the binary itself. |
I like the way the AlexAivazis/survey project does GIFs in their README. It looks like they use gfycat so that playing the GIF doesn't open the link into a new tab and taking you away from the README. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jeff-mccoy fixed a small grammatical issue but otherwise looks good! |
Description
This updates the README to reference docs and be visually cleaner.
Related Issue
None
Type of change
Checklist before merging