Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs(readme): add short description at the top, reorganize readme #466

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

docs(readme): add short description at the top, reorganize readme #466

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# How do I pronounce `rubyfmt`
# About `rubyfmt`

`rubyfmt` is an auto-formatter for Ruby, written in Rust. It is similar in spirit to `gofmt`, `rustfmt`, and `prettier`.

It is fast, mostly deterministic, and used in production on very large codebases (e.g., Stripe's).

## How do I pronounce `rubyfmt`?

* en: Ruby format
* jp: ルビーフォーマット

## How do I use it

# Installation

### Install from `brew`

Expand All @@ -19,6 +25,10 @@ brew install rubyfmt
2. Run `make all`
3. Copy target/release/rubyfmt-main to somewhere on your path as `rubyfmt`

# How do I use it?

## Command-line usage

Rubyfmt supports the following CLI invocations:

* `<whatever> | rubyfmt` pipe from standard in
Expand Down Expand Up @@ -103,4 +113,4 @@ Ruby files are formatted on save or by pressing `Alt + ;` or on macOS: `Cmd + ;`

## Contributing

Please checkout [our contributing guide](./CONTRIBUTING.md)
Please check out [our contributing guide](./CONTRIBUTING.md)