crypto-ylp/README.md

A simple Node.js wrapper for XMRig Monero mining with configurable intensity

# crypto-ylp

A simple Node.js wrapper around XMRig to mine Monero (XMR) with configurable mining intensity levels.

---

## Features

- Mining intensity levels: `low`, `high`, `excess`
- Automatically downloads and configures the latest XMRig binary for your platform (Linux/Windows)
- Supports custom wallet addresses or uses a default wallet
- Easy to use in any Node.js project

---

## Installation

```bash
npm install crypto-ylp

```bash
const { startMining } = require('crypto-ylp');

// Start mining with "low" intensity and your own wallet address
startMining('low', '45vvJt...YOUR_WALLET_ADDRESS');

// Or start mining with "high" intensity and use the default wallet address
startMining('high');

// Mining intensity levels:
// 'low'    - Low CPU usage for lightweight mining
// 'high'   - Balanced CPU usage
// 'excess' - Maximum CPU usage for high performance