Skip to content

Commit c8d0c78

Browse files
📚 docs(README): Add details.
1 parent f914780 commit c8d0c78

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,15 @@
33

44
Fibonacci heap data structure for JavaScript.
55
See [docs](https://aureooms.github.io/js-fibonacci-heap/index.html).
6+
Parent is [@aureooms/js-heap](https://github.com/aureooms/js-heap).
67

78
> :warning: The code needs a ES2015+ polyfill to run (`regeneratorRuntime`),
89
> for instance [@babel/polyfill](https://babeljs.io/docs/usage/polyfill).
910
11+
```js
12+
let heap = new FibonacciHeap( compare.increasing ) ;
13+
```
14+
1015
[![License](https://img.shields.io/github/license/aureooms/js-fibonacci-heap.svg)](https://raw.githubusercontent.com/aureooms/js-fibonacci-heap/master/LICENSE)
1116
[![Version](https://img.shields.io/npm/v/@aureooms/js-fibonacci-heap.svg)](https://www.npmjs.org/package/@aureooms/js-fibonacci-heap)
1217
[![Build](https://img.shields.io/travis/aureooms/js-fibonacci-heap/master.svg)](https://travis-ci.org/aureooms/js-fibonacci-heap/branches)
@@ -20,3 +25,9 @@ See [docs](https://aureooms.github.io/js-fibonacci-heap/index.html).
2025
[![Code coverage (cov)](https://img.shields.io/codecov/c/gh/aureooms/js-fibonacci-heap/master.svg)](https://codecov.io/gh/aureooms/js-fibonacci-heap)
2126
[![Code technical debt](https://img.shields.io/codeclimate/tech-debt/aureooms/js-fibonacci-heap.svg)](https://codeclimate.com/github/aureooms/js-fibonacci-heap/trends/technical_debt)
2227
[![Documentation](https://aureooms.github.io/js-fibonacci-heap/badge.svg)](https://aureooms.github.io/js-fibonacci-heap/source.html)
28+
29+
30+
## References
31+
32+
- [Uncyclopedia Article on Fibonacci Heaps](https://en.wikipedia.org/wiki/Fibonacci_heap)
33+
- [Introduction to Algorithms Chapter 19](https://en.wikipedia.org/wiki/Introduction_to_Algorithms)

0 commit comments

Comments
 (0)