Build Status Software License Release Gem Version Github commits (since latest release) GitHub repo size in bytes GitHub contributors

Kenny Speak

A silly Ruby Gem for converting text to Kenny Speak (Kenny from South Park).

Installation

Add this line to your application's Gemfile:

gem 'kenny_speak'

And then execute:

$ bundle

Or install it yourself as:

$ gem install kenny_speak

Usage

Encode.

  require 'kenny_speak'

  puts KennySpeak::Kenny.to_kenny(message)

  # or

  puts message.to_kenny

Decode

  require 'kenny_speak'

  puts KennySpeak::Kenny.from_kenny(message)

  # or

  puts message.from_kenny

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.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Testing

For local testing make sure that you run bundle exec rspec spec and then rake install to install the gem locally.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/WolfSoftware/kenny_speak. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the KennySpeak project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.