Skip to content

Commit e390647

Browse files
📚 docs: Improve README and usage examples.
1 parent 66a9ed5 commit e390647

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ Parent is [@aureooms/js-heap](https://github.com/aureooms/js-heap).
99
> [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
1010
1111
```js
12-
let heap = new FibonacciHeap( compare.increasing ) ;
12+
import {FibonacciHeap} from '@aureooms/js-fibonacci-heap';
13+
import {increasing} from '@aureooms/js-compare';
14+
let heap = new FibonacciHeap( increasing ) ;
1315
```
1416

1517
[![License](https://img.shields.io/github/license/aureooms/js-fibonacci-heap.svg)](https://raw.githubusercontent.com/aureooms/js-fibonacci-heap/main/LICENSE)

doc/manual/usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import 'regenerator-runtime/runtime.js' ;
1212

1313
Then, import the library where needed
1414
```js
15-
const fibonacciheap = require( '@aureooms/js-fibonacci-heap' ) ;
15+
const {FibonacciHeap} = require( '@aureooms/js-fibonacci-heap' ) ;
1616
// or
17-
import * as fibonacciheap from '@aureooms/js-fibonacci-heap' ;
17+
import {FibonacciHeap} from '@aureooms/js-fibonacci-heap' ;
1818
```

0 commit comments

Comments
 (0)