Skip to content

docs: restructure README with a quick-start section#733

Merged
Chemaclass merged 1 commit into
chore/remove-publish-docs-badgefrom
docs/simplify-readme
Jun 19, 2026
Merged

docs: restructure README with a quick-start section#733
Chemaclass merged 1 commit into
chore/remove-publish-docs-badgefrom
docs/simplify-readme

Conversation

@Chemaclass

@Chemaclass Chemaclass commented Jun 19, 2026

Copy link
Copy Markdown
Member

🤔 Background

The README sent every reader to bashunit.com for everything and leaned on marketing prose ("most modern", "very active community"), so it delivered no value on the page itself.

💡 Changes

  • Add a Quick start (install one-liner, a minimal test, the run command) so users can get going without leaving the page.
  • Trim the tagline and description to remove marketing fluff.
  • Drop the standalone Requirements section (folding "Bash 3.0+" into the intro) and tighten Contribute.

Stacked on #732 (Publish Docs badge removal). Retarget to main once that merges.

@Chemaclass Chemaclass added the documentation Improvements or additions to documentation label Jun 19, 2026
@Chemaclass Chemaclass self-assigned this Jun 19, 2026
@Chemaclass Chemaclass force-pushed the docs/simplify-readme branch from ebb4dbd to 486028a Compare June 19, 2026 12:44
@Chemaclass Chemaclass merged commit 809c1c0 into chore/remove-publish-docs-badge Jun 19, 2026
6 checks passed
@Chemaclass Chemaclass deleted the docs/simplify-readme branch June 19, 2026 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant