docs: update README with Playwright information, usage, links etc.

Author: jrolfs

README.md

@@ -1,27 +1,29 @@
-# pptr-testing-library
+# playwright-testing-library
 
-[![NPM Package](https://badge.fury.io/js/pptr-testing-library.svg)](https://www.npmjs.com/package/pptr-testing-library)
-[![Build Status](https://travis-ci.org/testing-library/pptr-testing-library.svg?branch=master)](https://travis-ci.org/testing-library/pptr-testing-library)
-[![Coverage Status](https://coveralls.io/repos/github/testing-library/pptr-testing-library/badge.svg?branch=master)](https://coveralls.io/github/testing-library/pptr-testing-library?branch=master)
-[![Dependencies](https://david-dm.org/testing-library/pptr-testing-library.svg)](https://david-dm.org/testing-library/pptr-testing-library)
+[![NPM Package](https://badge.fury.io/js/playwright-testing-library.svg)](https://www.npmjs.com/package/playwright-testing-library)
+[![Build Status](https://travis-ci.org/hoverinc/playwright-testing-library.svg?branch=master)](https://travis-ci.org/hoverinc/playwright-testing-library)
+[![Coverage Status](https://coveralls.io/repos/github/hoverinc/playwright-testing-library/badge.svg?branch=master)](https://coveralls.io/github/hoverinc/playwright-testing-library?branch=master)
+[![Dependencies](https://david-dm.org/hoverinc/playwright-testing-library.svg)](https://david-dm.org/hoverinc/playwright-testing-library)
 
-[puppeteer](https://github.com/GoogleChrome/puppeteer) + [@testing-library/dom](https://github.com/testing-library/dom-testing-library) = 💖
+[playwright](https://github.com/microsoft/playwright) + [@testing-library/dom](https://github.com/testing-library/dom-testing-library) = 💖
 
-All your favorite user-centric querying functions from @testing-library/react & @testing-library/library available from Puppeteer!
+All your favorite user-centric querying functions from @testing-library/react & @testing-library/library available from Playwright!
+
+> ⚠️ Note: this is a fork of [pptr-testing-library](https://github.com/testing-library/pptr-testing-library) modified to accomodate for some subtle API differences.
 
 ## Install
 
-`npm install --save-dev pptr-testing-library`
+`npm install --save-dev playwright-testing-library`
 
 ## Use
 
 ```js
-const puppeteer = require('puppeteer')
-const {getDocument, queries, wait} = require('pptr-testing-library')
+const {webkit} = require('playwright') // or 'firefox' or 'chromium'
+const {getDocument, queries, wait} = require('playwright-testing-library')
 
 const {getByTestId, getByLabelText} = queries
 
-const browser = await puppeteer.launch()
+const browser = await webkit.launch()
 const page = await browser.newPage()
 
 // Grab ElementHandle for document
@@ -30,19 +32,19 @@ const $document = await getDocument(page)
 const $form = await getByTestId($document, 'my-form')
 // returned elements are ElementHandles too!
 const $email = await getByLabelText($form, 'Email')
-// interact with puppeteer like usual
-await $email.type('pptr@example.com')
+// interact with playwright like usual
+await $email.type('playwright@example.com')
 // waiting works too!
 await wait(() => getByText($document, 'Loading...'))
 ```
 
-A little too un-puppeteer for you? We've got prototype-mucking covered too :)
+A little too un-playwright for you? We've got prototype-mucking covered too :)
 
 ```js
-const puppeteer = require('puppeteer')
-require('pptr-testing-library/extend')
+const {webkit} = require('playwright') // or 'firefox' or 'chromium'
+require('playwright-testing-library/extend')
 
-const browser = await puppeteer.launch()
+const browser = await webkit.launch()
 const page = await browser.newPage()
 
 // getDocument is added to prototype of Page
@@ -58,7 +60,7 @@ const {getByText} = $form.getQueriesForElement()
 
 Unique methods, not part of `@testing-library/dom`
 
-- `getDocument(page: puppeteer.Page): ElementHandle` - get an ElementHandle for the document
+- `getDocument(page: playwright.Page): ElementHandle` - get an ElementHandle for the document
 - `wait(conditionFn: () => {}): Promise<{}>` - wait for the condition to not throw (wrapper around `waitForExpect`)
 
 ---
@@ -95,17 +97,19 @@ Unique methods, not part of `@testing-library/dom`
 
 ## Known Limitations
 
-- `waitForElement` method is not exposed. Puppeteer has its own set of wait utilities that somewhat conflict with the style used in `@testing-library/dom`. See [#3](https://github.com/testing-library/pptr-testing-library/issues/3).
-- `fireEvent` method is not exposed, use puppeteer's built-ins instead.
+- `waitForElement` method is not exposed. Playwright has its own set of wait utilities that somewhat conflict with the style used in `@testing-library/dom`. See [#3](https://github.com/testing-library/playwright-testing-library/issues/3).
+- `fireEvent` method is not exposed, use Playwright's built-ins instead.
 - `expect` assertion extensions are not available.
 
 ## Special Thanks
 
-[@testing-library/dom](https://github.com/testing-library/dom-testing-library) of course!
+- [pptr-testing-library](https://github.com/testing-library/pptr-testing-library)
+- [@testing-library/dom](https://github.com/testing-library/dom-testing-library) of course!
 
-## Related Puppeteer Test Utilities
+## Related Playwright Test Utilities
 
-- [jest-puppeteer](https://github.com/smooth-code/jest-puppeteer)
+- [jest-playwright](https://github.com/playwright-community/jest-playwright)
+- [expect-playwright](https://github.com/playwright-community/expect-playwright)
 - Yours! Name TBD, PR welcome ;)
 
 ## LICENSE