Skip to content

Commit 96fa086

Browse files
authored
docs: update README.md with more instructions (#146)
1 parent f073a75 commit 96fa086

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
1-
# 🎭 [Playwright](https://github.com/microsoft/playwright) for Java
1+
# 🎭 [Playwright](https://playwright.dev) for Java
22

33
[![maven version](https://img.shields.io/maven-central/v/com.microsoft.playwright/playwright)](https://search.maven.org/search?q=com.microsoft.playwright) [![Join Slack](https://img.shields.io/badge/join-slack-infomational)](https://join.slack.com/t/playwright/shared_invite/enQtOTEyMTUxMzgxMjIwLThjMDUxZmIyNTRiMTJjNjIyMzdmZDA3MTQxZWUwZTFjZjQwNGYxZGM5MzRmNzZlMWI5ZWUyOTkzMjE5Njg1NDg)
44

5-
### _The project is in early development phase, the APIs match those in typescript version of Playwright but are subject to change._
5+
Playwright is a Java library to automate [Chromium](https://www.chromium.org/Home), [Firefox](https://www.mozilla.org/en-US/firefox/new/) and [WebKit](https://webkit.org/) with a single API. Playwright is built to enable cross-browser web automation that is **ever-green**, **capable**, **reliable** and **fast**.
6+
7+
| | Linux | macOS | Windows |
8+
| :--- | :---: | :---: | :---: |
9+
| Chromium <!-- GEN:chromium-version -->89.0.4344.0<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
10+
| WebKit 14.1 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
11+
| Firefox <!-- GEN:firefox-version -->84.0b9<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
12+
13+
Headless execution is supported for all the browsers on all platforms. Check out [system requirements](https://playwright.dev/#?path=docs/intro.md&q=system-requirements) for details.
614

715
## Usage
816

917
#### Add Maven dependency
1018

11-
To run Playwright simply add 2 modules to your Maven project:
19+
Playwright is distributed as a set of [Maven](https://maven.apache.org/what-is-maven.html) modules. The easiest way to use it is to add a couple of dependencies to your Maven `pom.xml` file as described below. If you're not familiar with Maven please refer to its [documentation](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html).
20+
21+
To run Playwright simply add two dependencies to your Maven project:
1222

1323
```xml
1424
<dependency>
@@ -146,9 +156,16 @@ public class InterceptNetworkRequests {
146156
}
147157
```
148158

149-
## Notes
159+
## Documentation
160+
161+
We are in the process of converting our documentation from the Node.js form to Javadocs. You can go ahead and use the Node.js [documentation](https://playwright.dev/) since the API is pretty much the same.
162+
163+
## Contributing
164+
165+
Follow [the instructions](https://github.com/microsoft/playwright-java/blob/master/CONTRIBUTING.md#getting-code) to build the project from source and install the driver.
150166

151-
Follow [the instructions](https://github.com/microsoft/playwright-java/blob/master/CONTRIBUTING.md#getting-code) to build the project from source and install driver.
167+
## Is Playwright for Java ready?
152168

153-
Original Playwright [documentation](https://playwright.dev/). We are converting it to javadoc.
169+
Yes, Playwright for Java is ready. We are still not at the version v1.0, so breaking API changes could potentially happen. But a) this is unlikely and b) we will only do that if we know it improves your experience with the new library. We'd like to collect your feedback before we freeze the API for v1.0.
154170

171+
> Note: We don't yet support some of the edge-cases of the vendor-specific APIs such as collecting Chromium trace, coverage report, etc.

0 commit comments

Comments
 (0)