README.md in kenny_speak-0.1.0 vs README.md in kenny_speak-1.0.0

- old
+ new

@@ -6,11 +6,11 @@ [![GitHub repo size in bytes](https://img.shields.io/github/repo-size/wolfsoftware/kenny_speak.svg)](https://github.com/wolfsoftware/kenny_speak) [![GitHub contributors](https://img.shields.io/github/contributors/wolfsoftware/kenny_speak.svg)](https://github.com/wolfsoftware/kenny_speak) # Kenny Speak -ToDo +A silly Ruby Gem for converting text to Kenny Speak (Kenny from South Park). ## Installation Add this line to your application's Gemfile: @@ -26,11 +26,37 @@ $ gem install kenny_speak ## Usage +### Encode. + ```ruby require 'kenny_speak' + + ks = KennySpeak.new + + puts ks.to_kenny(message) +``` + +### Decode + +```ruby + require 'kenny_speak' + + ks = KennySpeak.new + + puts ks.from_kenny(message) +``` + +### Command Line + +``` + Usage: kenny + -h, --help Display this screen + -d, --decode Should we be decoding a string? + -e, --encode Should we be encoding a string? + -m, --message string The message to send ``` ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.