README.md in ruby-beautify-0.93.2 vs README.md in ruby-beautify-0.94.0
- old
+ new
@@ -1,67 +1,71 @@
-# RBeautify
+# Ruby Beautify
+**Master** [](https://codeclimate.com/github/erniebrodeur/ruby-beautify) [](https://travis-ci.org/erniebrodeur/ruby-beautify) [](https://gemnasium.com/erniebrodeur/ruby-beautify)
+**Development** [](https://travis-ci.org/erniebrodeur/ruby-beautify)
+
[](https://gitter.im/erniebrodeur/ruby-beautify?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-This gem provides a cli binary named 'rbeautify' that will pretty up ruby code.
+This gem provides a cli binary named 'ruby-beautify' that will pretty up ruby code.
+Currenty, 'rbeautify' is included for backwards compatibility but will likely be phased out at some point.
## Installation
- % gem install ruby-beautify
+ % gem install ruby-beautify
## Usage
To Pretty up a file:
- % rbeautify filename
+ % ruby-beautify filename
Without a filename it reads from STDIN, suitable for piping:
- % curl 'http://example.org/ugly-file.rb' | rbeautify
+ % curl 'http://example.org/ugly-file.rb' | ruby-beautify
It has help:
- % rbeautify --help
+ % ruby-beautify --help
You can pick your indent character:
- % rbeautify --(t)abs
+ % ruby-beautify --(t)abs
- % rbeautify --(s)paces
+ % ruby-beautify --(s)paces
You can also pick the count of characters:
- % rbeautify --indent_(c)ount 1
+ % ruby-beautify --indent_(c)ount 1
Examples:
- % rbeautify -c 2 -s filename
+ % ruby-beautify -c 2 -s filename
- % rbeautify filename
+ % ruby-beautify filename
- % rbeautify -t -c 2 filename
+ % ruby-beautify -t -c 2 filename
## Bugs
- I don't have every ruby style tested against, so I expect some gaps. Feel free to submit issues (please include an example) and I'll figure out how to 'beautify' it.
+I don't have every ruby style tested against, so I expect some gaps. Feel free to submit issues (please include an example) and I'll figure out how to 'beautify' it.
-Please feel free to open issues, I am actively working on this project again, thanks entirely to the ripper gem.
+Please feel free to open issues, I am actively working on this project again, thanks entirely to the ripper gem.
## Todo
- * Add vim style comment hinting.
- * Add overwrite in place to files.
- * Add 'best guest' for files that fail syntax checking.
- * Add syntax checking to files rendered via STDIN.
+* Add vim style comment hinting.
+* Add overwrite in place to files.
+* Add 'best guest' for files that fail syntax checking.
+* Add syntax checking to files rendered via STDIN.
Longer term I'd like to do some more to assignment, line wrapping, and spacing in/around keywords.
## Contributing
- * fork it.
- * create it.
- * push it.
- * pull it.
+* fork it.
+* create it.
+* push it.
+* pull it.
# History
The original analyzer is available at: http://www.arachnoid.com/ruby/rubyBeautifier.html.