Add a table of contents to readme.md #168
Conversation
| @@ -4,6 +4,15 @@ | |||
|
|
|||
| [](https://travis-ci.org/sindresorhus/ava) [](https://ci.appveyor.com/project/sindresorhus/ava/branch/master) [](https://coveralls.io/github/sindresorhus/ava?branch=master) [](https://gitter.im/sindresorhus/ava?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | |||
|
|
|||
| Table of contents | |||
There was a problem hiding this comment.
Use the ## header style instead of underline.
|
Good idea! |
|
Oo yes, now to learn how to amend my commit 👍 Thank you @sindresorhus! |
|
@markthethomas You don't have to amend. You can just push new commits too. I usually squash commits and cleanup afterwards anyways ;) |
|
Sounds good! Need to learn though — I'm a solo dev where I work and don't get to use Git in these ways all that often (usually just me talking to me lol) :) |
|
Open source is definitely the best way to learn to use Git ;) |
|
Yes indeed! I think I just rebased and squashed the PR correctly? |
|
wait no — left the old TOC in there. Fixing! |
|
Btw, noticed that your created the PR from |
| @@ -6,6 +6,14 @@ | |||
|
|
|||
| 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) | |||
There was a problem hiding this comment.
Use - instead of * for the items
|
Oh ok — thanks for letting me know! I'll abandon this and create a new branch |
|
No, you can finish this one first. Since you can't change the branch of an existing PR. |
|
👍 (thanks for your patience while I fumble & learn) |
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
|
should be good to merge unless there's anything else that needs adding :) |
|
I've commented about https://github.com/sindresorhus/ava/pull/168/files#r44228402 twice ( |
|
Argh -- my bad Mark Sent from my iPhone @markthethomas everywhere
|
|
No worries :) |
Thought adding a streamlined TOC might make getting to some of the elements that are further down in the readme a little easier for reference usage. I didn't include every header/section since it ended up being too long 👍