Skip to content

Commit 635bd90

Browse files
📚 docs: Update.
1 parent 3fddc85 commit 635bd90

File tree

4 files changed

+20
-11
lines changed

4 files changed

+20
-11
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
</p>
1010

1111
Randomness algorithms for JavaScript.
12-
See [docs](https://randomized-algorithm.github.io/random).
12+
See [docs](https://randomized-algorithm.github.io/random/index.html).
1313
Parent is [js-algorithms](https://make-github-pseudonymous-again.github.io/js-algorithms).
1414

1515
> :warning: Depending on your environment, the code may require

doc/manual/installation.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,22 @@
11
# Installation
2+
23
Can be managed using
3-
[jspm](http://jspm.io)
4-
or [npm](https://github.com/npm/npm).
4+
[yarn](https://yarnpkg.com/en/docs),
5+
[npm](https://docs.npmjs.com),
6+
or [jspm](https://jspm.org/docs).
57

6-
### jspm
8+
9+
### yarn
710
```terminal
8-
jspm install npm:@randomized/random
11+
yarn add @randomized/random
912
```
1013

1114
### npm
1215
```terminal
1316
npm install @randomized/random --save
1417
```
18+
19+
### jspm
20+
```terminal
21+
jspm install npm:@randomized/random
22+
```

doc/manual/usage.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@
44
> `regeneratorRuntime` to be defined, for instance by importing
55
> [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
66
7+
First, require the polyfill at the entry point of your application
78
```js
8-
await import( 'regenerator-runtime/runtime.js' ) ;
9+
await import('regenerator-runtime/runtime.js');
910
// or
10-
import 'regenerator-runtime/runtime.js' ;
11+
import 'regenerator-runtime/runtime.js';
1112
```
1213

13-
Then
14+
Then, import the library where needed
1415
```js
15-
const { ... } = await import( '@randomized/random' ) ;
16+
const { ... } = await import('@randomized/random');
1617
// or
17-
import { ... } from '@randomized/random' ;
18+
import { ... } from '@randomized/random';
1819
```

doc/scripts/header.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const domReady = function (callback) {
1010
domReady(() => {
1111
const projectname = document.createElement('a');
1212
projectname.classList.add('project-name');
13-
projectname.text = 'randomized/random';
13+
projectname.text = '@randomized/random';
1414
projectname.href = './index.html';
1515

1616
const header = document.querySelector('header');

0 commit comments

Comments
 (0)