Skip to content

Commit 5fced45

Browse files
committed
docs: more readme tweaks
1 parent 0960143 commit 5fced45

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
[![NPM Package](https://badge.fury.io/js/pptr-testing-library.svg)](https://www.npmjs.com/package/pptr-testing-library)
44
[![Build Status](https://travis-ci.org/patrickhulce/pptr-testing-library.svg?branch=master)](https://travis-ci.org/patrickhulce/pptr-testing-library)
55
[![Coverage Status](https://coveralls.io/repos/github/patrickhulce/pptr-testing-library/badge.svg?branch=master)](https://coveralls.io/github/patrickhulce/pptr-testing-library?branch=master)
6-
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
76
[![Dependencies](https://david-dm.org/patrickhulce/pptr-testing-library.svg)](https://david-dm.org/patrickhulce/pptr-testing-library)
87

98
[puppeteer](https://github.com/GoogleChrome/puppeteer) + [dom-testing-library](https://github.com/kentcdodds/dom-testing-library) = 💖
@@ -50,9 +49,11 @@ const $form = queries.getByTestId(document, 'my-form')
5049

5150
## API
5251

53-
- `getDocument(page: puppeteer.Page)`
54-
- `extendObjectWithTestingUtils(handle: ElementHandle)`
55-
- `queries`
52+
See [dom-testing-libary](https://github.com/kentcdodds/dom-testing-library#usage) API for more. All `get*`/`query*` methods are supported.
53+
54+
- `getDocument(page: puppeteer.Page): ElementHandle` - get an ElementHandle for the document
55+
- `extendObjectWithTestingUtils(handle: ElementHandle): ElementHandle & TestingUtils` - extend the input object with
56+
- `queries: TestingUtils` - the query subset of `dom-testing-library` exports
5657
- `queryByPlaceholderText`
5758
- `queryAllByPlaceholderText`
5859
- `getByPlaceholderText`
@@ -77,3 +78,11 @@ const $form = queries.getByTestId(document, 'my-form')
7778
- `queryAllByTitle`
7879
- `getByTitle`
7980
- `getAllByTitle`
81+
82+
## Special Thanks
83+
84+
[dom-testing-library](https://github.com/kentcdodds/dom-testing-library) of course!
85+
86+
## LICENSE
87+
88+
MIT

0 commit comments

Comments
 (0)