Skip to content

Tighten README prose and consolidate option list#6

Merged
hogelog merged 2 commits intomainfrom
docs-trim-readme-further
Apr 24, 2026
Merged

Tighten README prose and consolidate option list#6
hogelog merged 2 commits intomainfrom
docs-trim-readme-further

Conversation

@aka-hogelog
Copy link
Copy Markdown
Contributor

@aka-hogelog aka-hogelog Bot commented Apr 24, 2026

Summary

  • Collapsed the three-paragraph intro into two sentences. The "not a native binary compiler" framing is folded into the same line that notes the runtime Ruby dependency.
  • Moved options into a single ## Options section with one-line descriptions. Added --path DIR to that list instead of re-enumerating every flag in a trailing sentence.
  • Dropped the shebang-passthrough edge-case note.

Kept each usage variant (pack / gem pack / gem install) in its own code block with a short lead-in, rather than one consolidated block.

Test plan

  • Render README.md on GitHub and confirm formatting looks right

@hogelog hogelog merged commit d55dacc into main Apr 24, 2026
4 checks passed
@hogelog hogelog deleted the docs-trim-readme-further branch April 24, 2026 15:08
@aka-hogelog aka-hogelog Bot mentioned this pull request Apr 25, 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.

1 participant