Skip to content

README.md

Latest commit

 

History

History
66 lines (42 loc) · 1.75 KB

README.md

File metadata and controls

66 lines (42 loc) · 1.75 KB

CleanWords

A clean (i.e. "kid friendly") random word generator.

Currently the word list varies in size from 4 to 12 letters in length and consists mostly of words for animals, food, plants, and buildings.

Installation

Add this line to your application's Gemfile:

gem 'clean_words'

And then execute:

$ bundle

Or install it yourself as:

$ gem install clean_words

Usage

words = CleanWords::Random.new

# Fetch a random word
words.fetch
#=> 'aspen'

# Fetch a number of random words
words.fetch(nil, 3)
#=> ['aspen', 'terrier', 'apple']

# Fetch a random word of a particular size
words.fetch(6)
#=> 'arctic'

# Fetch random words of an array of sizes
words.fetch([4,6], 2)
#=> ['arctic', 'fort']

# Fetch random words of a range of sizes
words.fetch((4..6), 4)
#=> ['fort', 'gopher', 'arctic', 'maple']

Contributing

  1. Fork it ( https://github.com/foraker/clean_words/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  • NOTE: If adding words to data/words.txt, please execute ruby util/sanitize_list.rb from the project root before commiting.
  1. Push to the branch (git push origin my-new-feature)
  2. Create a new Pull Request

About Foraker Labs

Foraker Logo

Foraker Labs builds exciting web and mobile apps in Boulder, CO. Our work powers a wide variety of businesses with many different needs. We love open source software, and we're proud to contribute where we can. Interested to learn more? Contact us today.

This project is maintained by Foraker Labs. The names and logos of Foraker Labs are fully owned and copyright Foraker Design, LLC.