@botport/core/README.md

Unified framework for Discord bot products, published by BotPort.

<div align="center">
	<br />
	<p>
		<img src="https://raw.githubusercontent.com/BotPortOfficial/core/main/.github/workflows/banner.png" width="546" alt="BotPort core" />
	</p>
	<p>
	    <a href="https://discord.gg/sRyU4GFraG"><img src="https://img.shields.io/discord/1383201315072639058?color=5865F2&logo=discord&logoColor=white" alt="Discord server" /></a>
		<a href="https://github.com/BotPortOfficial/core"><img src="https://img.shields.io/github/last-commit/BotPortOfficial/core?logo=github&logoColor=white&style=flat-square" alt="Last commit" /></a>
		<a href="https://www.npmjs.com/package/@botport/core"><img src="https://badgen.net/npm/v/@botport/core" alt="NPM version" /></a>
		<a href="https://github.com/BotPortOfficial/core/graphs/contributors"><img src="https://img.shields.io/github/contributors/BotPortOfficial/core?logo=github&logoColor=white&color=blue&style=flat-square" alt="Contributors" /></a>
		<a href="https://github.com/BotPortOfficial/core/blob/main/LICENSE"><img src="https://img.shields.io/github/license/BotPortOfficial/core?style=flat-square" alt="License" /></a>
	</p>
	<br />
</div>

## 📋 About

**BotPort core** is a specialized npm package designed exclusively for BotPort's Discord bot ecosystem. This package provides core management functionality and is optimized for integration with our proprietary Discord bot infrastructure.

> ⚠️ **Important Notice**: This package is built specifically for BotPort's internal Discord bot systems. We do not provide support, documentation, or assistance for external implementations or third-party usage.

## 🚀 Features

- ✅ Seamless Discord bot integration
- ✅ Optimized for BotPort's bot ecosystem
- ✅ Lightweight and efficient
- ✅ Regular updates and maintenance

## 📦 Installation

```bash
npm install @botport/core
```

```bash
yarn add @botport/core
```

## 🔧 Used Dependencies

This package relies on the following dependencies to provide its core functionality:

### Production Dependencies
| Package | Version | Purpose |
|---------|---------|---------|
| [`chalk`](https://www.npmjs.com/package/chalk) | `^5.3.0` | Terminal string styling and colorization |
| [`dotenv`](https://www.npmjs.com/package/dotenv) | `^16.3.1` | Environment variable loading from .env files |
| [`mysql2`](https://www.npmjs.com/package/mysql2) | `^3.6.0` | MySQL database client with Promise support |
| [`@npmcli/arborist`](https://www.npmjs.com/package/@npmcli/arborist) | `^9.1.2` | Package dependency tree management |
| [`latest-version`](https://www.npmjs.com/package/latest-version) | `9.0.0` | Get the latest version of an npm package |

### Peer Dependencies
| Package | Version | Purpose |
|---------|---------|---------|
| [`discord.js`](https://www.npmjs.com/package/discord.js) | `^14.0.0` | Discord API library for Node.js |

## 🏗️ Projects Using This Package

The following BotPort projects utilize `@botport/core`:

### Official BotPort Projects
- **[BotPort Nexus](https://github.com/BotPortOfficial/nexus)** - Advanced modular discord bot

## 📄 License

This project is licensed under the [MIT licence](https://github.com/BotPortOfficial/core/blob/main/LICENSE).

---

<div align="center">
	<sub>Built with ❤️ by the BotPort Team</sub>
</div>