Skip to content

Commit 532419d

Browse files
committed
Updating documentation
1 parent 23e8ee1 commit 532419d

8 files changed

Lines changed: 13 additions & 12 deletions

File tree

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![Build Status](https://github.com/avoidwork/tiny-lru/actions/workflows/ci.yml/badge.svg)](https://github.com/avoidwork/tiny-lru/actions)
77
[![Test Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)](https://github.com/avoidwork/tiny-lru)
88

9-
A **high-performance, lightweight** LRU cache for JavaScript with **fastest UPDATES and competitive SET/GET/DELETE** and **compact bundle size**. Built for developers who need fast caching without compromising on features.
9+
A **high-performance, lightweight** LRU cache for JavaScript with **strong UPDATE performance and competitive SET/GET/DELETE**, and a **compact bundle size**. Built for developers who need fast caching without compromising on features.
1010

1111
## 📦 Installation
1212

@@ -50,9 +50,9 @@ tempCache.set('session', 'abc123'); // Automatically expires after 5 seconds
5050

5151
### Why Choose Tiny LRU?
5252

53-
- **🔄 Excellent Cache Updates** - 348K UPDATE ops/sec, outperforming alternatives by 2.6x
54-
- **📦 Compact Bundle** - Just 2.2 KiB minified for a full-featured LRU library
55-
- **⚖️ Balanced Performance** - Strong across all operations with O(1) complexity
53+
- **🔄 Strong Cache Updates** - Excellent performance in update-heavy workloads
54+
- **📦 Compact Bundle** - Just ~2.2 KiB minified for a full-featured LRU library
55+
- **⚖️ Balanced Performance** - Competitive across all operations with O(1) complexity
5656
- **⏱️ TTL Support** - Optional time-to-live with automatic expiration
5757
- **🔄 Method Chaining** - Fluent API for better developer experience
5858
- **🎯 TypeScript Ready** - Full TypeScript support with complete type definitions
@@ -71,6 +71,7 @@ tempCache.set('session', 'abc123'); // Automatically expires after 5 seconds
7171
Notes:
7272
- Mean values computed from the Performance Summary across 5 consecutive runs of `npm run benchmark:comparison`.
7373
- mnemonist lacks a compatible delete method in this harness, so DELETE ops/sec is 0.
74+
- Performance varies by hardware, Node.js version, and workload patterns; run the provided benchmarks locally to assess your specific use case.
7475
- Environment: Node.js v24.5.0, macOS arm64.
7576

7677
## 📊 Performance Deep Dive

dist/tiny-lru.cjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* @copyright 2025 Jason Mulligan <jason.mulligan@avoidwork.com>
55
* @license BSD-3-Clause
6-
* @version 11.4.4
6+
* @version 11.4.5
77
*/
88
'use strict';
99

dist/tiny-lru.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* @copyright 2025 Jason Mulligan <jason.mulligan@avoidwork.com>
55
* @license BSD-3-Clause
6-
* @version 11.4.4
6+
* @version 11.4.5
77
*/
88
/**
99
* A high-performance Least Recently Used (LRU) cache implementation with optional TTL support.

dist/tiny-lru.min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/tiny-lru.umd.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* @copyright 2025 Jason Mulligan <jason.mulligan@avoidwork.com>
55
* @license BSD-3-Clause
6-
* @version 11.4.4
6+
* @version 11.4.5
77
*/
88
(function(g,f){typeof exports==='object'&&typeof module!=='undefined'?f(exports):typeof define==='function'&&define.amd?define(['exports'],f):(g=typeof globalThis!=='undefined'?globalThis:g||self,f(g.lru={}));})(this,(function(exports){'use strict';/**
99
* A high-performance Least Recently Used (LRU) cache implementation with optional TTL support.

dist/tiny-lru.umd.min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "tiny-lru",
33
"description": "A high-performance, lightweight LRU cache. Built for developers who need fast caching without compromising on features.",
4-
"version": "11.4.4",
4+
"version": "11.4.5",
55
"homepage": "https://github.com/avoidwork/tiny-lru",
66
"author": "Jason Mulligan <jason.mulligan@avoidwork.com>",
77
"repository": {

0 commit comments

Comments
 (0)