0.0
No commit activity in last 3 years
No release in over 3 years
A tiny Ruby library that generates human readable "tokens" that are easy to read and remember. end
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.0
~> 0.3
~> 5.0
~> 10.0
~> 0.7.1
~> 0.8
 Project Readme

readable-token

Build Status Gem Version

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