@rezzon8/math-utils 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,134 @@
+# @rezzon8/math-utils
+
+Basic math utility functions with TypeScript support.
+
+## Installation
+
+```bash
+npm install @rezzon8/math-utils
+```
+
+## Usage
+
+```typescript
+import { add, subtract, multiply, divide } from '@rezzon8/math-utils'
+
+// Addition
+const sum = add(5, 3) // 8
+
+// Subtraction
+const difference = subtract(10, 4) // 6
+
+// Multiplication
+const product = multiply(6, 7) // 42
+
+// Division
+const quotient = divide(20, 5) // 4
+
+// Division by zero throws an error
+try {
+  divide(10, 0)
+} catch (error) {
+  console.error(error.message) // "Division by zero is not allowed"
+}
+```
+
+## API
+
+### `add(a: number, b: number): number`
+
+Returns the sum of two numbers.
+
+**Parameters:**
+
+- `a` - First number
+- `b` - Second number
+
+**Returns:** The sum of `a` and `b`
+
+---
+
+### `subtract(a: number, b: number): number`
+
+Returns the difference of two numbers.
+
+**Parameters:**
+
+- `a` - First number
+- `b` - Second number
+
+**Returns:** The difference (`a - b`)
+
+---
+
+### `multiply(a: number, b: number): number`
+
+Returns the product of two numbers.
+
+**Parameters:**
+
+- `a` - First number
+- `b` - Second number
+
+**Returns:** The product of `a` and `b`
+
+---
+
+### `divide(a: number, b: number): number`
+
+Returns the quotient of two numbers.
+
+**Parameters:**
+
+- `a` - Dividend
+- `b` - Divisor
+
+**Returns:** The quotient (`a / b`)
+
+**Throws:** Error if `b` is zero
+
+---
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Run tests
+npm test
+
+# Run tests in watch mode
+npm run test:watch
+
+# Build the package
+npm run build
+
+# Lint code
+npm run lint
+
+# Fix linting issues
+npm run lint:fix
+
+# Format code
+npm run format
+
+# Check formatting
+npm run format:check
+```
+
+## Features
+
+- ✅ TypeScript support with full type definitions
+- ✅ ESM modules
+- ✅ Comprehensive test coverage with Vitest
+- ✅ Modern ESLint + Prettier configuration
+- ✅ Source maps included
+
+## Repository
+
+[https://github.com/rezzon8/npm-package](https://github.com/rezzon8/npm-package)
+
+## License
+
+ISC © 2025

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rezzon8/math-utils",
-  "version": "1.0.0",
-  "description": "Basic math utility functions",
+  "version": "1.0.1",
+  "description": "Basic set of math utility functions",
   "keywords": [
     "math",
     "utilities",