tiny-electron-essentials/README.md

A lightweight and modular utility library for Electron apps, offering simplified window management, tray support, IPC channels, and custom frameless window styling.

<div align="center">
<p>
    <a href="https://discord.gg/TgHdvJd"><img src="https://img.shields.io/discord/413193536188579841?color=7289da&logo=discord&logoColor=white" alt="Discord server" /></a>
    <a href="https://www.npmjs.com/package/tiny-electron-essentials"><img src="https://img.shields.io/npm/v/tiny-electron-essentials.svg?maxAge=3600" alt="NPM version" /></a>
    <a href="https://www.npmjs.com/package/tiny-electron-essentials"><img src="https://img.shields.io/npm/dt/tiny-electron-essentials.svg?maxAge=3600" alt="NPM downloads" /></a>
    <a href="https://www.patreon.com/JasminDreasond"><img src="https://img.shields.io/badge/donate-patreon-F96854.svg?logo=patreon" alt="Patreon" /></a>
    <a href="https://ko-fi.com/jasmindreasond"><img src="https://img.shields.io/badge/donate-ko%20fi-29ABE0.svg?logo=ko-fi" alt="Ko-Fi" /></a>
</p>
<p>
    <a href="https://nodei.co/npm/tiny-electron-essentials/"><img src="https://nodei.co/npm/tiny-electron-essentials.png?downloads=true&stars=true" alt="npm installnfo" /></a>
</p>
</div>

# 🚀 Tiny-Electron-Essentials

A modular toolkit for simplifying Electron app development.
Provides a set of reusable helpers to manage windows, tray, IPC, notifications, and more with clean and consistent APIs.

---

## 🧠 What is this?

**`tiny-electron-essentials`** is a minimalistic utility library designed to speed up the development of Electron applications.

It offers reliable helpers for:

* 🪟 Window creation and management
* 🖥️ Tray icon control
* 🔗 IPC event handling
* 🔔 Native notifications
* 🏗️ CSS-based custom window frames
* 🔥 App lifecycle control with single-instance locks
* 🌐 Proxy management, file loaders, and more

Everything is built with clarity and extensibility in mind.

---

## 📦 NPM Module

```bash
npm install tiny-electron-essentials
```

---

## 📂 Project Structure

| Folder       | Description                                              |
| ------------ | -------------------------------------------------------- |
| **`src/`**   | 🧠 Main source code for the entire module                |
| **`tests/`** | 🧪 Automated tests for core functionality                |
| **`docs/`**  | 📚 Full documentation with API descriptions and examples |

---

## 📚 Documentation

Full documentation is available in the [`docs/`](./docs) folder.

> ✔️ Includes detailed explanations for all modules:
> Global utilities, Main process controllers, Preload IPC bridges, and more.

---

## 🔗 Useful Links

* 🧠 [View Documentation](./docs)
* 📦 [tiny-electron-essentials on npm](https://www.npmjs.com/package/tiny-electron-essentials)

---

## 🛠️ Requirements

* Electron v23 or higher
* Node.js v18 or higher

---

## 📝 License

This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details.

> 🧠 **Note**: This documentation was written by [ChatGPT](https://openai.com/chatgpt), an AI assistant developed by OpenAI, based on the project structure and descriptions provided by the repository author.  
> If you find any inaccuracies or need improvements, feel free to contribute or open an issue!