max-say/README.md

A fun console library that displays a cute text dog with 'Я собаня' message

# Max Say 🐕

Забавная библиотека для npm, которая выводит в консоль милую текстовую собаку с сообщением "Я собаня"!

## Установка

```bash
npm install max-say
```

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

### Как библиотека

#### ES6 модули (рекомендуется)

```typescript
import MaxSay from 'max-say';

const maxSay = new MaxSay();

// Показать собаку с сообщением по умолчанию
console.log(maxSay.say());
// Выведет: собаку с "Я собаня"

// Показать собаку с кастомным сообщением
console.log(maxSay.say('Привет, мир!'));

// Показать собаку с кастомным шрифтом
console.log(maxSay.sayWithFont('Круто!', 'Block'));
```

#### CommonJS модули

```javascript
// Способ 1: Деструктуризация (рекомендуется)
const { MaxSay } = require('max-say');

// Способ 2: Через default
// const MaxSay = require('max-say').default;

const maxSay = new MaxSay();

// Показать собаку с сообщением по умолчанию
console.log(maxSay.say());

// Показать собаку с кастомным сообщением
console.log(maxSay.say('Привет, мир!'));

// Показать собаку с кастомным шрифтом
console.log(maxSay.sayWithFont('Круто!', 'Block'));
```

### Как CLI инструмент

```bash
# Показать собаку по умолчанию
npx max-say

# Показать собаку с кастомным сообщением
npx max-say "Привет, мир!"

# Показать собаку с кастомным шрифтом
npx max-say -f Block "Круто!"

# Показать справку
npx max-say --help
```

## Доступные шрифты

- `Standard` - стандартный шрифт
- `Block` - блочный шрифт
- `Bubble` - пузырьковый шрифт
- `Lean` - наклонный шрифт
- `Mini` - миниатюрный шрифт
- `Script` - рукописный шрифт
- `Slant` - наклонный шрифт
- `Small` - маленький шрифт
- `Big` - большой шрифт
- `Digital` - цифровой шрифт

## API

### `MaxSay(options?)`

Создает новый экземпляр MaxSay.

**Параметры:**

- `options.message` - сообщение по умолчанию
- `options.font` - шрифт по умолчанию

### `say(message?)`

Возвращает собаку с сообщением в текстовом виде.

**Параметры:**

- `message` - сообщение для отображения (опционально)

### `sayWithFont(message?, font?)`

Возвращает собаку с сообщением в указанном шрифте.

**Параметры:**

- `message` - сообщение для отображения (опционально)
- `font` - название шрифта (опционально)

## Пример вывода

```
┌─────────────┐
│ Я собаня    │
└─────────────┘

    /\___/\
   (  o o  )
   (  =^=  )
    (______)
     |  |  |
     |  |  |
    _|  |  |_
   (______|__)
```

## 🔄 Совместимость

Библиотека полностью совместима с:

- ✅ **ES6 модули** (import/export) - современные проекты
- ✅ **CommonJS** (require/module.exports) - старые проекты Node.js
- ✅ **TypeScript** - с полной поддержкой типов
- ✅ **Node.js** - все версии от 14+

### CommonJS примеры

```javascript
// Деструктуризация (рекомендуется)
const { MaxSay } = require('max-say');

// Или через default
const MaxSay = require('max-say').default;

const maxSay = new MaxSay();
console.log(maxSay.say('Привет!'));
```

## Лицензия

MIT