@vicimpa/nick-name/README.md

Nick name generator for JavaScript

# @vicimpa/nick-name

## Генератор Никнеймов для JavaScript

Создавайте уникальные никнеймы с легкостью с помощью этой JavaScript библиотеки.
Вдохновлено [nick-name.ru](https://nick-name.ru/).

## Установка

Для установки библиотеки используйте npm:

```bash
npm install @vicimpa/nick-name --save
```

## Использование

Вот как вы можете использовать библиотеку в вашем проекте:

```js
const genName = require("nick-name");

// Генерация никнеймов с использованием различных методов
const nickName1 = genName(1); // Первый метод генерации
const nickName2 = genName(2); // Второй метод генерации
const nickName3 = genName(3); // Третий метод генерации
```

### Функция `genName` и её аргументы

- **method** - _number_ (1 до 3): Указывает метод генерации. По умолчанию 1.
- **length** - _number_ (3 до 15): Указывает длину никнейма. По умолчанию
  случайная длина.

Пример с использованием необязательных аргументов:

```js
const customNickName = genName(2, 10); // Использует второй метод и устанавливает длину в 10 символов
```

### Методы Генерации

1. **Первый метод**: Генерация никнеймов на основе случайного набора символов.
2. **Второй метод**: Генерация никнеймов на основе словарного подхода, используя
   заранее определенные слова и их комбинации.
3. **Третий метод**: Генерация никнеймов на основе алгоритмов машинного обучения
   для создания более естественных и запоминающихся имен.

### Примеры Использования

#### Простой пример

```js
const genName = require("nick-name");

const nickName = genName(); // Использует метод по умолчанию (1) и случайную длину
console.log(nickName); // Пример вывода: "Cedenatamonteu"
```

#### Пример с указанием метода

```js
const genName = require("nick-name");

const nickName = genName(2); // Использует второй метод генерации
console.log(nickName); // Пример вывода: "Yneramyr"
```

#### Пример с указанием метода и длины

```js
const genName = require("nick-name");

const nickName = genName(3, 8); // Использует третий метод и длину в 8 символов
console.log(nickName); // Пример вывода: "Britarie"
```

### Дополнительные Возможности

- **Кастомизация**: Возможность добавления своих словарей для генерации
  никнеймов.
- **Интеграция**: Легко интегрируется с любыми JavaScript проектами, включая
  Node.js и браузерные приложения.
- **Поддержка**: Регулярные обновления и поддержка сообщества.

### Обратная Связь

Если у вас есть предложения или вы нашли ошибку, пожалуйста, создайте issue на
[GitHub](https://github.com/vicimpa/nick-name/issues).