Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 734 Bytes

README.md

File metadata and controls

31 lines (21 loc) · 734 Bytes
Raw

pic-word-gen

Version npm

A word generator module for using in a pictionary

Installation


npm install pic-word-gen

Usage

  • To generate a word, require the module and call generateWord function
  • Pass in the level of difficulty of the words as a parameter to the generateWord function
  • Allowed levels are
    • easy
    • medium
    • hard
  • Default level is easy if no level is passed to the generateWord function

const wordgen = require('pic-word-gen')

let easyWord = wordgen.generateWord('easy')
let mediumWord = wordgen.generateWord('medium')
let hardWord = wordgen.generateWord('hard')