Skip to content

Commit 7440ac9

Browse files
committed
minor readme tweaks
1 parent b54eafa commit 7440ac9

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

readme.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@
66

77
Even though JavaScript is single-threaded, IO in Node.js can happen in parallel due to its async nature. AVA takes advantage of this and runs your tests concurrently, which is especially beneficial for IO heavy tests. In addition, test files are run in parallel as separate processes, giving you even better performance and an isolated environment for each test file. [Switching](https://github.com/sindresorhus/pageres/commit/663be15acb3dd2eb0f71b1956ef28c2cd3fdeed0) from Mocha to AVA in Pageres brought the test time down from 31 sec to 11 sec. Having tests run concurrently forces you to write atomic tests, meaning tests don't depend on global state or the state of other tests, which is a great thing!
88

9+
![](media/screenshot-mini-reporter.gif)
10+
911
*Read our [contributing guide](contributing.md) if you're looking to contribute (issues/PRs/etc).*
1012

1113
Follow the [AVA Twitter account](https://twitter.com/ava__js) for updates.
1214

1315
Translations: [Español](https://github.com/avajs/ava-docs/blob/master/es_ES/readme.md), [Français](https://github.com/avajs/ava-docs/blob/master/fr_FR/readme.md), [Italiano](https://github.com/avajs/ava-docs/blob/master/it_IT/readme.md), [日本語](https://github.com/avajs/ava-docs/blob/master/ja_JP/readme.md), [한국어](https://github.com/avajs/ava-docs/blob/master/ko_KR/readme.md), [Português](https://github.com/avajs/ava-docs/blob/master/pt_BR/readme.md), [Русский](https://github.com/avajs/ava-docs/blob/master/ru_RU/readme.md), [简体中文](https://github.com/avajs/ava-docs/blob/master/zh_CN/readme.md)
1416

15-
## Table of Contents
17+
## Contents
1618

1719
- [Usage](#usage)
1820
- [CLI Usage](#cli)
@@ -174,17 +176,17 @@ When using `npm test`, you can pass positional arguments directly `npm test test
174176

175177
The mini-reporter is the default reporter.
176178

177-
![](media/screenshot-mini-reporter.gif)
179+
<img src="media/screenshot-mini-reporter.gif" width="460">
178180

179181
### Verbose reporter
180182

181-
The verbose reporter is always used in CI environments unless [`--tap`](#tap-reporter) is specified. Use the [`--verbose` flag](#verbose-reporter) to enable verbose output.
183+
Use the `--verbose` flag to enable the verbose reporter. This is always used in CI environments unless the [TAP reporter](#tap-reporter) is enabled.
182184

183185
<img src="media/screenshot.png" width="150">
184186

185187
### TAP reporter
186188

187-
AVA supports the TAP format and thus is compatible with any [TAP reporter](https://github.com/sindresorhus/awesome-tap#reporters). Use the [`--tap` flag](#tap-reporter) to enable TAP output.
189+
AVA supports the TAP format and thus is compatible with [any TAP reporter](https://github.com/sindresorhus/awesome-tap#reporters). Use the `--tap` flag to enable TAP output.
188190

189191
```console
190192
$ ava --tap | tap-nyan

0 commit comments

Comments
 (0)