readable-token

A tiny Ruby library for generating human readable "tokens".

Installation

Add this line to your Gemfile:

gem 'readable-token'

And then execute:

bundle install

Require the gem in your code:

require 'readable-token'

Usage

Generate a token

ReadableToken.generate          # => "barista-spoon-1"
ReadableToken.generate(min: 20) # => "doughnut-fork-aroma-7"
ReadableToken.generate(max: 10) # => "penguin-2"

Loading your own word list

ReadableToken.words = %w(cat penguin password)
ReadableToken.generate

Development

Development Commands

# run all tests and build code coverage
bundle exec rake test

# hints where to improve docs
bundle exec inch