Skip to content

Commit e40954f

Browse files
authored
docs: update README (#13)
1 parent d00192a commit e40954f

1 file changed

Lines changed: 5 additions & 16 deletions

File tree

README.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,21 @@ available in Node.js 14 and later.
88

99
Minimal dependencies, with full test suite.
1010

11-
If we discover bugs in this implementation, I'm going to report them back to
12-
node core.
13-
1411
Differences from the core implementation:
1512

16-
- Doesn't hide its own stack frames
13+
- Doesn't hide its own stack frames.
1714

1815
## Docs
1916

20-
> https://github.com/nodejs/node/blob/adaf60240559ffb58636130950262ee3237b7a41/doc/api/test.md
21-
22-
# Test runner
23-
24-
<!--introduced_in=REPLACEME-->
17+
### Test runner
2518

2619
> Stability: 1 - Experimental
2720
2821
<!-- source_link=lib/test.js -->
2922

3023
The `node:test` module facilitates the creation of JavaScript tests that
31-
report results in [TAP][] format. To access it:
24+
report results in [TAP][] format. This package is a port of `node:test`.
25+
To access it:
3226

3327
```mjs
3428
import test from 'test'
@@ -105,7 +99,7 @@ As a test file executes, TAP is written to the standard output of the Node.js
10599
process. This output can be interpreted by any test harness that understands
106100
the TAP format. If any tests fail, the process exit code is set to `1`.
107101

108-
## Subtests
102+
#### Subtests
109103

110104
The test context's `test()` method allows subtests to be created. This method
111105
behaves identically to the top level `test()` function. The following example
@@ -414,11 +408,6 @@ behaves in the same fashion as the top level [`test()`][] function.
414408
[`test()`]: #testname-options-fn
415409
[test runner execution model]: #test-runner-execution-model
416410

417-
## Kudos
418-
419-
Thank you [@aduh95](https://github.com/aduh95) for sharing the new `node:test`
420-
module in the [@transloadit](https://github.com/transloadit) Slack.
421-
422411
## License
423412

424413
MIT

0 commit comments

Comments
 (0)