friendlier-words v1.1.3

friendlier-words

friendlier-words is a JavaScript package that creates friendly words to use in your app, e.g. in project names. It's based off the library by Glitch, but with some choice improvements:

• Curated the word lists to remove strange word combinations
• Generated categories of words rather than objects, allowing for more flexibility
• Allow for a custom number of segments
• Allow for a custom separator

Possible permutations:

• 2 words: 401,736
• 3 words: 707,858,832
• 4 words: 1,247,247,261,984
• 5 words: heat death of the universe

Installation

pnpm add friendlier-words

Usage

import { friendlyWords } from 'friendlier-words';

// Default (2 segments, '-')
const words = friendlyWords();

// Custom (3 segments, '_')
const words = friendlyWords(3, '_');