Skip to content

Commit 329bb56

Browse files
📚 docs: Fix import examples and add emojis.
1 parent ce9d723 commit 329bb56

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
[@aureooms/js-pairing-heap](https://aureooms.github.io/js-pairing-heap)
1+
:cherries: [@aureooms/js-pairing-heap](https://aureooms.github.io/js-pairing-heap)
22
==
33

44
<img src="https://cdn.rawgit.com/aureooms/js-pairing-heap/main/media/sketch.svg" width="864">
55

6-
Pairing heap data structure library for JavaScript.
6+
Pairing heap data structure for JavaScript.
77
See [docs](https://aureooms.github.io/js-pairing-heap/index.html).
88
Parent is [@aureooms/js-heap](https://github.com/aureooms/js-heap).
99

1010
```js
11-
let heap = new PairingHeap( compare.increasing ) ;
11+
import {increasing} from '@aureooms/js-compare';
12+
import {PairingHeap} from '@aureooms/js-pairing-heap';
13+
let heap = new PairingHeap( increasing ) ;
1214
```
1315

1416
[![License](https://img.shields.io/github/license/aureooms/js-pairing-heap.svg)](https://raw.githubusercontent.com/aureooms/js-pairing-heap/main/LICENSE)
@@ -26,6 +28,6 @@ let heap = new PairingHeap( compare.increasing ) ;
2628
[![Documentation](https://aureooms.github.io/js-pairing-heap/badge.svg)](https://aureooms.github.io/js-pairing-heap/source.html)
2729

2830

29-
## References
31+
## :scroll: References
3032

3133
- [Improved bounds for multipass pairing heaps and path-balanced binary search trees](https://arxiv.org/abs/1806.08692)

doc/manual/usage.md

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

1111
Then
1212
```js
13-
const pairingheap = require( '@aureooms/js-pairing-heap' ) ;
13+
const {PairingHeap} = require( '@aureooms/js-pairing-heap' ) ;
1414
// or
15-
import pairingheap from '@aureooms/js-pairing-heap' ;
15+
import {PairingHeap} from '@aureooms/js-pairing-heap' ;
1616
```

0 commit comments

Comments
 (0)