@axi-engine/utils 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,37 @@
+# @axi-engine/utils
+
+[![NPM version](https://img.shields.io/npm/v/@axi-engine/utils.svg)](https://www.npmjs.com/package/@axi-engine/utils)
+
+Core utility library for Axi Engine. 
+
+Provides a set of common, standalone functions for arrays, math, type guards, random generation, and more.
+
+## Installation
+
+```bash
+npm install @axi-engine/utils
+```
+
+## Usage
+
+Here are a few examples of how to use the utilities from this package:
+
+```typescript
+import { randInt, clampNumber, haveSameElements } from '@axi-engine/utils';
+
+// Get a random integer
+const diceRoll = randInt(1, 7); // Returns a number between 1 and 6
+
+// Clamp a value
+const health = clampNumber(120, 0, 100); // Returns 100
+
+// Compare arrays without order
+const isSame = haveSameElements(['a', 'b'], ['b', 'a']); // Returns true
+```
+
+API Reference
+
+A full API documentation, automatically generated from the source code, is available here:
+
+[Full API Documentation](./docs/api/README.md)
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axi-engine/utils",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Core utility library for Axi Engine, providing common functions for arrays, math, type guards, and more.",
   "license": "MIT",
   "keywords": [
@@ -14,6 +14,7 @@
   "types": "./dist/index.d.ts",
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "docs": "typedoc src/index.ts --out docs/api --options ../../typedoc.json",
     "test": "echo 'No tests yet for @axi-engine/utils'"
   },
   "files": [