> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zopio.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Friendlier Words

> A JavaScript package that creates friendly words to use in your app, handy for generating project names.

### Installation

To install `friendlier-words`, simply run the following command:

```sh Terminal theme={"system"}
pnpm add friendlier-words
```

### Usage

Here is an example of how to use `friendlier-words` for generating friendly words:

```tsx get-project-name.ts theme={"system"}
import { friendlyWords } from 'friendlier-words';

// Default (2 segments, '-')
// e.g. robust-chicken, happy-cat, modest-pear
const words = friendlyWords();

// Custom (3 segments, '_')
// e.g. keen_explorer_oak, comforting_cactus_constructor, playful_tiger_breeze
const words = friendlyWords(3, '_');
```

### Benefits

* <Icon icon="check" iconType="solid" /> **Easy to Use**: `friendlier-words` is easy to use and generates friendly words with a simple API.
* <Icon icon="check" iconType="solid" /> **Customizable**: You can customize the number of segments and the separator.