Reorganize the README #810
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fables-tales
requested changes
Jan 19, 2026
README.md
Outdated
|
|
||
| ## FAQ | ||
|
|
||
| **How do I pronounce rubyfmt?** |
Owner
There was a problem hiding this comment.
let's move this up top, otherwise I think this is good
Owner
|
fixes #424 |
fables-tales
approved these changes
Jan 20, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This rearranges the README to be more friendly to folks who don't already know what
rubyfmtis. It leads with a one-liner about what it does, a link to rubyfmt.run to see it in action, and then tells them how to install and run it. It also updates the CLI flag docs in a bit more of a structured table format with separate sections for the different ignore mechanisms (headers and.rubyfmtignore/.gitignore).The editor integrations are largely the same, though I did add a section for a
ruby-lspplugin since the old Ruby VSCode extension is now deprecated. I also put in a section on Rubocop since there were several open issues about it. (The ruby-lsp add-on and the rubocop-rubyfmt gem mentioned are mine, just plugging them since it doesn't seem like other community options exist/still work for these two cases.)I also kept the pronunciation / maintenance policy here but just moved them to the bottom -- they're helpful to have, but not the first thing users need to see.