Skip to content

Commit 5810d7a

Browse files
📚 docs: Update regeneratorRuntime warning.
1 parent 39f50fc commit 5810d7a

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
Tape library for JavaScript. Served with asynchronous goodness.
66
See [docs](https://async-abstraction.github.io/tape/index.html).
77

8-
> :warning: The code requires `regeneratorRuntime` to be defined, for instance by importing
8+
> :warning: Depending on your environment, the code may require
9+
> `regeneratorRuntime` to be defined, for instance by importing
910
> [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
1011
1112
```js

doc/manual/usage.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# Usage
22

3-
> :warning: The code requires `regeneratorRuntime` to be defined, for instance by importing
3+
> :warning: Depending on your environment, the code may require
4+
> `regeneratorRuntime` to be defined, for instance by importing
45
> [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
56
67
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

1314
Then, import the library where needed
1415
```js
15-
const tape = await import( '@async-abstraction/tape' ) ;
16+
const tape = await import('@async-abstraction/tape');
1617
// or
17-
import tape from '@async-abstraction/tape' ;
18+
import * as tape from '@async-abstraction/tape';
1819
```

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
"author": "make-github-pseudonymous-again",
77
"homepage": "https://async-abstraction.github.io/tape",
88
"repository": {
9-
"type": "git",
10-
"url": "https://github.com/async-abstraction/tape"
9+
"url": "https://github.com/async-abstraction/tape",
10+
"type": "git"
1111
},
1212
"bugs": {
1313
"url": "https://github.com/async-abstraction/tape/issues"

0 commit comments

Comments
 (0)