From 0cfee68039e6505e8bc8e6e628126f8e677d894c Mon Sep 17 00:00:00 2001 From: Alex Rattray Date: Sat, 25 May 2024 15:22:23 -0400 Subject: [PATCH] docs(readme): add short description at the top, reorganize readme --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d6837a20..470e12af 100644 --- a/README.md +++ b/README.md @@ -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` @@ -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: * ` | rubyfmt` pipe from standard in @@ -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)