Skip to content

Commit a716e90

Browse files
docs: update README.md (testing-library#292)
1 parent d49c33f commit a716e90

File tree

1 file changed

+48
-28
lines changed

1 file changed

+48
-28
lines changed

README.md

+48-28
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@
1111
</a>
1212

1313
<p>Fire events the same way the user does</p>
14-
15-
<br />
1614
</div>
1715

1816
---
@@ -24,30 +22,13 @@
2422
[![downloads][downloads-badge]][npmtrends]
2523
[![MIT License][license-badge]][license]
2624

27-
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
25+
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
26+
[![All Contributors](https://img.shields.io/badge/all_contributors-31-orange.svg?style=flat-square)](#contributors-)
27+
<!-- ALL-CONTRIBUTORS-BADGE:END -->
2828
[![PRs Welcome][prs-badge]][prs]
2929
[![Code of Conduct][coc-badge]][coc]
3030
<!-- prettier-ignore-end -->
3131

32-
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
33-
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
34-
35-
- [The problem](#the-problem)
36-
- [The solution](#the-solution)
37-
- [Installation](#installation)
38-
- [API](#api)
39-
- [`click(element)`](#clickelement)
40-
- [`dblClick(element)`](#dblclickelement)
41-
- [`async type(element, text, [options])`](#async-typeelement-text-options)
42-
- [`upload(element, file, [{ clickInit, changeInit }])`](#uploadelement-file--clickinit-changeinit-)
43-
- [`clear(element)`](#clearelement)
44-
- [`selectOptions(element, values)`](#selectoptionselement-values)
45-
- [`tab({shift, focusTrap})`](#tabshift-focustrap)
46-
- [Contributors](#contributors)
47-
- [LICENSE](#license)
48-
49-
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
50-
5132
## The problem
5233

5334
From
@@ -64,6 +45,28 @@ change the state of the checkbox.
6445

6546
**The library is still a work in progress and any help is appreciated.**
6647

48+
## Table of Contents
49+
50+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
51+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
52+
53+
- [Installation](#installation)
54+
- [API](#api)
55+
- [`click(element)`](#clickelement)
56+
- [`dblClick(element)`](#dblclickelement)
57+
- [`async type(element, text, [options])`](#async-typeelement-text-options)
58+
- [`upload(element, file, [{ clickInit, changeInit }])`](#uploadelement-file--clickinit-changeinit-)
59+
- [`clear(element)`](#clearelement)
60+
- [`selectOptions(element, values)`](#selectoptionselement-values)
61+
- [`tab({shift, focusTrap})`](#tabshift-focustrap)
62+
- [Issues](#issues)
63+
- [🐛 Bugs](#-bugs)
64+
- [💡 Feature Requests](#-feature-requests)
65+
- [Contributors ✨](#contributors-)
66+
- [LICENSE](#license)
67+
68+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
69+
6770
## Installation
6871

6972
With NPM:
@@ -326,10 +329,27 @@ it('should cycle elements in document tab order', () => {
326329
})
327330
```
328331

329-
## Contributors
332+
## Issues
333+
334+
_Looking to contribute? Look for the [Good First Issue][good-first-issue]
335+
label._
336+
337+
### 🐛 Bugs
338+
339+
Please file an issue for bugs, missing documentation, or unexpected behavior.
340+
341+
[**See Bugs**][bugs]
330342

331-
Thanks goes to these wonderful people
332-
([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):
343+
### 💡 Feature Requests
344+
345+
Please file an issue to suggest new features. Vote on feature requests by adding
346+
a 👍. This helps maintainers prioritize what to work on.
347+
348+
[**See Feature Requests**][requests]
349+
350+
## Contributors ✨
351+
352+
Thanks goes to these people ([emoji key][emojis]):
333353

334354
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
335355
<!-- prettier-ignore-start -->
@@ -380,11 +400,11 @@ Thanks goes to these wonderful people
380400

381401
<!-- markdownlint-enable -->
382402
<!-- prettier-ignore-end -->
403+
383404
<!-- ALL-CONTRIBUTORS-LIST:END -->
384405

385-
This project follows the
386-
[all-contributors](https://github.com/all-contributors/all-contributors)
387-
specification. Contributions of any kind welcome!
406+
This project follows the [all-contributors][all-contributors] specification.
407+
Contributions of any kind welcome!
388408

389409
## LICENSE
390410

0 commit comments

Comments
 (0)