king-of-random-generator/README.md

Generate random number. Enjoy!

📋Table of Contents

* Features
* Installation
* Usage
* API
* CLI
* Examples
* Keywords

✨ **Features**

🔢 **Random Integers**: Generate integers within any range.
💯 **Random Positive**: Generate non-negative integers from 0 up to a maximum.
👤 **Developer Name**: Retrieve the module's developer name.

⚙️ **Installation**

Install from npm:

```bash
npm install king-of-random-generator
```

> **Note:** Do not prefix the package name with a hyphen (e.g., `npm install -king-of-random-generator`), as npm will interpret it as a flag.

🚀 **Usage**

```js
import { random, randomPositive, getDeveloperName } from "king-of-random-generator";

// 🎯 Random integer between 5 and 15 (inclusive)
console.log(random(5, 15)); // e.g. 12

// 🎯 Random positive integer up to 20 (inclusive)
console.log(randomPositive(20)); // e.g. 17

// 🧑‍💻 Developer name
console.log(getDeveloperName()); // "king-of-random-generator"
```

📦 **API**

| Method                | Signature                              | Description                             |
| --------------------- | -------------------------------------- | --------------------------------------- |
| `random(min, max)`    | `(min: number, max: number) => number` | Returns an integer ≥ `min` and ≤ `max`. |
| `randomPositive(max)` | `(max: number) => number`              | Returns an integer ≥ 0 and ≤ `max`.     |
| `getDeveloperName()`  | `() => string`                         | Returns the developer name string.      |

💻 **CLI**

Install locally (non-global):

```bash
npm install king-of-random-generator
```

Or as a dev dependency:

```bash
npm install --save-dev king-of-random-generator
```

Use via `npx`:

```bash
npx king-of-random-generator --int 1 100    # prints a random integer between 1 and 100
npx king-of-random-generator --range 10 1 50 # prints 10 random integers between 1 and 50
```

📂 **Examples**

See the `examples/` directory for quick-start templates and advanced use cases.

🔑 **Keywords**

```
random random-number random-positive developer-name king-of-random-generator
```