zakir-core 0.1.1 → 0.1.2

package/README.md

@@ -1,7 +1,174 @@
 # @zakir/core
 
-Zero-dependency core utility library.
+Zero-dependency, lightweight utility library for modern JavaScript & TypeScript projects.  
+Focuses on **performance**, **correct Unicode handling**, and **predictable behavior**.
+
+---
+
+## Features
+
+- 🚫 Zero dependencies
+- ⚡ Fast & minimal
+- 🌍 Locale-aware string utilities (Unicode safe)
+- 🧠 LRU-based memoization
+- ⏱️ Debounce & throttle with full control
+- 🧩 Functional helpers (pipe / compose)
+- ✅ TypeScript-first
+
+---
 
 ## Install
+
 ```bash
 npm i @zakir/core
+```
+
+```ts
+import { debounce, slugify, memoize } from "@zakir/core"
+```
+
+---
+
+## Core Utilities
+
+### Functions
+- `noop`, `identity`
+- `once`, `onceAsync`
+- `delay`, `defer`
+- `tryCatch`
+
+```ts
+const init = once(() => console.log("init"))
+init()
+init() // ignored
+```
+
+---
+
+## Timing
+
+### debounce / throttle
+
+Fully featured (leading, trailing, maxWait):
+
+```ts
+const fn = debounce(
+  () => console.log("run"),
+  300,
+  { leading: true }
+)
+
+fn.cancel()
+fn.flush()
+fn.pending()
+```
+
+`throttle` is implemented via `debounce` for consistency.
+
+---
+
+## Memoization
+
+### memoize
+
+- Optional key resolver
+- Optional LRU cache (`maxSize`)
+- Manual cache control
+
+```ts
+const fib = memoize(
+  (n: number): number => n <= 1 ? n : fib(n - 1) + fib(n - 2),
+  n => n,
+  { maxSize: 100 }
+)
+
+fib.cache.clear()
+```
+
+### memoizeAsync
+
+- Caches Promises
+- Auto-cleans rejected results
+
+---
+
+## Functional Composition
+
+```ts
+const fn = pipe(
+  (x: number) => x + 1,
+  x => x * 2
+)
+
+fn(2) // 6
+```
+
+Also available: `compose(...)`
+
+---
+
+## String Utilities (Unicode-Safe)
+
+Locale-aware, grapheme-safe string helpers:
+
+- `capitalize`, `capitalizeWords`
+- `lower`, `upper`
+- `truncate`, `reverse`
+- `slugify`
+- `extractInitials`
+- `removeDiacritics`
+- `equalsIgnoreCase`
+- `startsWithIgnoreCase`, `includesIgnoreCase`
+
+```ts
+slugify("Heydər Əliyev") 
+// => "heyder-eliyev"
+```
+
+---
+
+## Transliteration
+
+Built-in support for AZ/TR characters. Extendable:
+
+```ts
+extendTransliteration({
+  "ß": "ss"
+})
+```
+
+---
+
+## Locale-Aware Comparison
+
+```ts
+compareLocale("ə", "z", "az-AZ")
+```
+
+Uses `Intl.Collator` when available with LRU caching.
+
+---
+
+## Browser & Node
+
+Works in:
+- Browsers
+- Node.js
+- Bun / Deno
+
+Uses `performance.now()` when available, falls back safely.
+
+---
+
+## Philosophy
+
+- Explicit > Magic
+- Correctness > Shortcuts
+- Zero runtime dependencies
+- Small primitives you can trust
+
+---
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zakir-core",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Core utility functions – zero dependency",
   "type": "module",
   "main": "dist/index.js",