Skip to content

Commit

Permalink
📚 docs(README): Add tldr snippet.
Browse files Browse the repository at this point in the history
  • Loading branch information
make-github-pseudonymous-again committed Oct 26, 2020
1 parent 77ef64a commit 1e6e96e
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,28 @@
:notebook_with_decorative_cover: [@aureooms/js-in-situ-sort-spec](https://aureooms.github.io/js-in-situ-sort-spec)
==

In-place sorting spec for JavaScript. Parent is
[aureooms/js-sort](https://github.com/aureooms/js-sort).
In-place sorting specification for JavaScript.
See [docs](https://aureooms.github.io/js-in-situ-sort-spec).
Parent is [@aureooms/js-sort](https://github.com/aureooms/js-sort).

```js
import ava from 'ava';
import * as spec from '@aureooms/js-in-situ-sort-spec';

spec.test(
ava, // Any testing library exhibiting the same interface as `ava`.
[
[
'mock', // Name of the implementation.
(compare, a, i, j) => spec.mock(compare, a, i, j), // Sorting implementation.
]
],
{
length: [24, 1000], // Array lengths to test.
array: [Int8Array], // Array types to test.
}
);
```

[![License](https://img.shields.io/github/license/aureooms/js-in-situ-sort-spec.svg)](https://raw.githubusercontent.com/aureooms/js-in-situ-sort-spec/master/LICENSE)
[![Version](https://img.shields.io/npm/v/@aureooms/js-in-situ-sort-spec.svg)](https://www.npmjs.org/package/@aureooms/js-in-situ-sort-spec)
Expand Down

0 comments on commit 1e6e96e

Please sign in to comment.