fables-tales / rubyfmt

Ruby Autoformatter!
MIT License
1.07k stars 50 forks source link

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

Open rattrayalex opened 3 months ago

rattrayalex commented 3 months ago

I wasn't sure what this project really was or how it worked.

I'm still not very sure, but figured this guess, informed by a conversation with a friend who uses the project, might be better than nothing.

You're more than welcome to totally redo it, use parts of it, or make no changes.

If you'd like to take it even further, I might suggest adding whether it uses wadler's algorithm, in what cases it'll "listen" to the user's preferences vs format from the AST in whole cloth, and provide a few examples of its opinions in before/after format.