@kottetall/random 0.0.3 → 0.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kottetall/random",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -14,7 +14,20 @@
     "type": "git",
     "url": "git+https://github.com/kottetall/random.git"
   },
-  "keywords": [],
+  "keywords": [
+    "random",
+    "random-utils",
+    "utility",
+    "utils",
+    "helpers",
+    "javascript",
+    "node",
+    "array",
+    "object",
+    "picker",
+    "random-picker",
+    "random-value"
+  ],
   "author": "",
   "license": "ISC",
   "type": "commonjs",

package/readme.md

@@ -0,0 +1,56 @@
+# Random
+
+A lightweight utility library for generating pseudo-random values in JavaScript based of `Math.random()`.
+
+This package was originally created for personal use in my own projects, but it is published as an open tool that anyone can use. It focuses on simple, practical helpers for working with randomness, such as picking random values from arrays or objects.
+
+## Features
+
+- Get a random value from an array
+- Get a random value from an object
+- Get a random letter
+- Get a random truthy/falsy value
+- And more...
+- Simple and minimal API
+- Zero dependencies
+- Designed for everyday use in JavaScript and Node.js projects
+
+## Installation
+
+```bash
+npm install @kottetall/random
+```
+
+## Usage
+
+### Random value from an array
+
+```js
+import { Random } from "@kottetall/random";
+
+const items = ["apple", "banana", "orange"];
+const result = Random.fromArray(items);
+
+console.log(result);
+```
+
+### Random value from an object
+
+```js
+import { Random } from "@kottetall/random";
+
+const obj = {
+  a: 1,
+  b: 2,
+  c: 3,
+};
+
+const result = Random.fromObject(obj);
+
+console.log(result);
+```
+
+## Why this package?
+
+Sometimes you just need small, reusable helpers instead of rewriting the same logic in every project.
+This package aims to provide clean and simple functions for common random-related tasks.