fast-median - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "fast-median",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Find median of an array in amortized linear time",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -1,2 +0,37 @@
-# fast-median
-npm package for finding the median element in an array in average case linear time
+## fast-median
+Find median element in an arary of numbers
+
+Uses a randomized quickselect to achieve O(n) average case time complexity
+
+[![Build Status](https://travis-ci.org/gm758/fast-median.svg?branch=master)](https://travis-ci.org/gm758/fast-median)
+
+## Install
+```bash
+$ npm install fast-median
+```
+
+## Usage
+```js
+import median from 'fast-median'
+
+median([10, 20, 30, 40])
+// 25
+
+median([10, 20, 30, 40, 50])
+// 30
+
+median([1])
+// 1
+
+```
+
+## API
+```js
+median :: number a => [a] -> a
+
+median(numbers)
+```
+
+__Arguments__
+* `numbers` - An array of numbers
+

No alert changes

Improved metrics

Total package byte prevSize

6046

increased by9.51%

Number of package files

9

increased by12.5%

Number of lines in readme file

38

increased by1166.67%

No dependency changes