📚 docs(README): Add import snippet.

randomized-algorithm · Dec 11, 2020 · 9a1d16e · 9a1d16e
1 parent fb17109
commit 9a1d16e
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,15 @@ Randomness algorithms for JavaScript.
 See [docs](https://aureooms.github.io/js-random).
 Parent is [@aureooms/js-algorithms](https://aureooms.github.io/js-algorithms).
 
+```js
+import {
+	randint , // randint(i, j) -> [i, j[ \cap ZZ
+	randfloat , // randfloat(i, j) -> [i, j[
+	sample , // /!\ in-place
+	shuffle , // /!\ in-place
+} from '@aureooms/js-random' ;
+```
+
 [![License](https://img.shields.io/github/license/aureooms/js-random.svg)](https://raw.githubusercontent.com/aureooms/js-random/main/LICENSE)
 [![Version](https://img.shields.io/npm/v/@aureooms/js-random.svg)](https://www.npmjs.org/package/@aureooms/js-random)
 [![Build](https://img.shields.io/travis/aureooms/js-random/main.svg)](https://travis-ci.org/aureooms/js-random/branches)