feat: update to support CommonJS + update readme

vinroger · Aug 28, 2024 · 22faec1 · 22faec1
1 parent 1e03da6
commit 22faec1
Show file tree

Hide file tree

Showing 19 changed files with 477 additions and 154 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,5 @@
 node_modules
-.npmrc
+.npmrc
+
+dist
+node_modules
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,2 @@
+scripts
+src
diff --git a/README.md b/README.md
@@ -14,6 +14,25 @@ Install quick-median with npm:
 npm install quick-median
 ```
 
+### CommonJS
+```javascript
+const { findMedian } = require('quick-median');
+
+const arr = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
+const median = findMedian(arr);
+console.log(median); // 5.5
+```
+
+### ES Module (TypeScript Supported)
+```javascript
+import findMedian from 'quick-median';
+
+const arr = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
+const median = findMedian(arr);
+console.log(median); // 5.5
+
+```
+
 ## Why this project?
 
 Many existing median-finding packages on npm are not optimized for performance. This project implements the Floyd-Rivest algorithm, a highly efficient selection algorithm that outperforms traditional quickselect in practice.

diff --git a/dist/cjs/index.d.ts b/dist/cjs/index.d.ts
diff --git a/dist/cjs/index.js b/dist/cjs/index.js
@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.findMedian = findMedian;
 function SELECT(X, L, R, K) {
     while (R > L) {
         if (R - L > 600) {

diff --git a/dist/esm/index.d.ts b/dist/esm/index.d.ts
diff --git a/dist/esm/index.js b/dist/esm/index.js
diff --git a/dist/index.d.ts b/dist/index.d.ts
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.min.js b/dist/index.min.js