inklog/README.md

A colorful and beautiful terminal logger for Node.js with fixed-width output and smart default messages.

# ✨ inklog

> A clean, colorful terminal logger for Node.js — 80-character styled logs for success, error, warning, and info.

---

**👨‍💻 Developed by [CodingOtt Systems](https://www.codingott.com)**  
**🏷️ Tagline: _Building career without degree_**

---

## 🚀 Features

- 📏 Fixed-width 80-character layout
- 🎨 Colored `SUCCESS`, `ERROR`, `WARNING`, `INFO` labels
- 🧾 Dimmed and wrapped messages
- 🧠 Smart default fallback messages
- 🪶 Lightweight and easy to use

---

## 📦 Installation

```bash
npm install inklog
# or
yarn add inklog
```

---

## 📖 Usage

```ts
import { successLog, errorLog, infoLog, warningLog } from 'inklog';

successLog('User created successfully');
errorLog('Failed to connect to the database');
infoLog('Server is running on port 3000');
warningLog('Low disk space detected');
```

---

### 🧪 Output

Example output (with colors):

```
[SUCCESS] User created successfully                          00:00:01 PM
[ERROR  ] Failed to connect to the database                  00:00:02 PM
[INFO   ] Server is running on port 3000                     00:00:03 PM
[WARNING] Low disk space detected                            00:00:04 PM
```

> The logger keeps each line neatly within 80 characters.

---

## 🧰 API

### `successLog(message?: string)`
Logs a green success message.

### `errorLog(message?: string)`
Logs a red error message.

### `infoLog(message?: string)`
Logs a blue info message.

### `warningLog(message?: string)`
Logs a yellow warning message.

---

## 🧱 Why Inklog?

Most logging libraries dump too much information or no style at all. `inklog` keeps it:

- ✨ **Clean** — fixed-width output
- 🎯 **Focused** — only the message and time
- 🌈 **Colorful** — consistent styling out of the box

---

## 🤝 Contributing

Pull requests and feature suggestions are welcome!

---

## 📄 License

MIT © [CodingOtt Systems](https://www.codingott.com)