https://github.com/haydenbleasel/friendlier-words

A bunch of words that are combined to generate unique names.
https://github.com/haydenbleasel/friendlier-words

friendly generator name project words

Last synced: 2 days ago
JSON representation

A bunch of words that are combined to generate unique names.

• Host: GitHub
• URL: https://github.com/haydenbleasel/friendlier-words
• Owner: haydenbleasel
• License: mit
• Created: 2023-07-03T19:35:07.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-18T15:29:10.000Z (27 days ago)
• Last Synced: 2024-11-03T12:02:40.422Z (11 days ago)
• Topics: friendly, generator, name, project, words
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/friendlier-words
• Size: 592 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# friendlier-words



  

  

  

  



![friendlier-words](/sample.png)

`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](https://github.com/glitchdotcom/friendly-words), 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

```bash

pnpm add friendlier-words

```

## Usage

```ts

import { friendlyWords } from 'friendlier-words';

// Default (2 segments, '-')

const words = friendlyWords();

// Custom (3 segments, '_')

const words = friendlyWords(3, '_');

```