README.md in rubyx-0.0.1 vs README.md in rubyx-0.0.2

- old
+ new

@@ -1,19 +1,56 @@ -# Ruby X +# Rubyx [![Gem Version](https://badge.fury.io/rb/rubyx.svg)](http://badge.fury.io/rb/rubyx) -A tool to run a Ruby script while showing the executed command, just like -`bash -x`. +A tool to run a Ruby script while showing the executed lines of code. ## Installation ```bash $ gem install rubyx ``` ## Usage -```bash -$ rubyx file.rb +``` +$ rubyx -h +Usage: rubyx [options] <file> -- [arguments] + +Options: + -i PREFIX Set prefix for source code (default: "") + -o PREFIX Set prefix for standard output (default: "# => ") + -h Show this message +``` + +## Example + +``` +$ rubyx input.rb > output.rb +``` + +In `input.rb`: + +```ruby +def say + puts 'Hello!' +end + +say + +puts 'Bye!' +``` + +In `output.rb`: + +```ruby +def say + puts 'Hello!' +end + +say +# => Hello! + +puts 'Bye!' +# => Bye! ``` ## Contributing 1. [Fork](https://help.github.com/articles/fork-a-repo) the project.