Skip to content

Commit

Permalink
Add a table of contents to readme.md
Browse files Browse the repository at this point in the history
Thought adding a streamlined TOC might make getting to some of the elements that are further down in the readme a little easier. I didn't include every header/section since it ended up being too long

Conform to rest of Readme style; move below intro
  • Loading branch information
markthethomas committed Nov 8, 2015
1 parent ff8031f commit 4f8bfac
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@

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 a 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 that don't depend on global state or the state of other tests, which is a great thing!

## Table of contents
* [Usage](#usage)
* [CLI Usage](#cli)
* [Documentation](#documentation)
* [API](#api)
* [Assertions](#assertions)
* [FAQ](#api)

## Why AVA?

Expand Down Expand Up @@ -550,4 +557,3 @@ Concurrency is not parallelism. It enables parallelism. It's about dealing with,
<br>
<br>
</div>

This comment has been minimized.

Copy link
@markthethomas

markthethomas Nov 8, 2015

Author Contributor

Don't know why that's getting stripped; maybe something with my editor

This comment has been minimized.

Copy link
@sindresorhus

sindresorhus Nov 8, 2015

Member

Yes, try installing an EditorConfig plugin and your editor will abide by the .editorconfig file in this repo ;)

http://editorconfig.org/

This comment has been minimized.

Copy link
@markthethomas

markthethomas Nov 8, 2015

Author Contributor

👍

This comment has been minimized.

Copy link
@markthethomas

markthethomas Nov 8, 2015

Author Contributor

So a default in Atom's core whitespace package was overriding the editorconfig; I'll push again shortly 👍

0 comments on commit 4f8bfac

Please sign in to comment.