Skip to content
This repository was archived by the owner on Jul 30, 2020. It is now read-only.

Commit baf59e4

Browse files
committed
docs: add table of contents [ci skip]
1 parent 61347d4 commit baf59e4

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,22 @@
2828
[![Watch on GitHub](https://img.shields.io/github/watchers/bcarroll22/native-testing-library.svg?style=social)](https://github.com/bcarroll22/native-testing-library/watchers)
2929
[![Star on GitHub](https://img.shields.io/github/stars/bcarroll22/native-testing-library.svg?style=social)](https://github.com/bcarroll22/native-testing-library/stargazers)
3030

31+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
32+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
33+
34+
## Table of Contents
35+
36+
- [The problem](#the-problem)
37+
- [This solution](#this-solution)
38+
- [Example](#example)
39+
- [Guiding principles](#guiding-principles)
40+
- [Installation](#installation)
41+
- [Hooks](#hooks)
42+
- [Inspiration](#inspiration)
43+
- [Other Solutions](#other-solutions)
44+
45+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
46+
3147
## The problem
3248

3349
You want to write maintainable tests for your React Native application. You love Kent Dodds' testing
@@ -146,6 +162,6 @@ that library with this one somehow.
146162
## Other Solutions
147163

148164
The awesome engineers at [Callstack](https://callstack.com/) built a similar package called
149-
[`react-native-testing-library`](https://github.com/callstack/react-native-testing-library).
150-
If you find yourself needing things like shallow rendering and the ability to query elements
165+
[`react-native-testing-library`](https://github.com/callstack/react-native-testing-library).
166+
If you find yourself needing things like shallow rendering and the ability to query elements
151167
by type and props, you'll definitely want to check it out!

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"commit": "git-cz",
1414
"commit:add": "git add .",
1515
"commit:all": "npm run commit:add && npm run commit",
16+
"readme:toc": "doctoc README.md --maxlevel 3 --title '## Table of Contents'",
1617
"test": "jest",
1718
"pretty-quick": "pretty-quick --staged --pattern '**/*.(js|jsx|ts|tsx)'",
1819
"prepublish": "rm -rf dist; babel src --out-dir dist --ignore 'src/__tests__/*'",

0 commit comments

Comments
 (0)