Skip to content

Update README with links to official docs #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anaulin merged 1 commit into from
Nov 27, 2018
Merged

Update README with links to official docs #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 5 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,11 @@

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.percy/percy-java-selenium/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.percy/percy-java-selenium)

Java Selenium library for visual regression testing with Percy.

## Building and packaging
[Percy](https://percy.io) visual testing for Java Selenium.

This package uses the default [Maven build lifecycle](https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html), so you can use the standard Maven commands for compiling and packaging. The most common ones are:

To compile:
```bash
$ mvn compile
```

To build a packaged JAR:
```bash
$ mvn package
```
This will create a .jar file in the `target/` directory.

To clean all the artifacts of a previous build:
```bash
$ mvn clean
```
## Resources

* [Setup and integration docs](https://docs.percy.io/docs/java-selenium)
* [Tutorial](https://docs.percy.io/v1/docs/java-selenium-testing-tutorial)
* [Example integration](https://github.com/percy/example-percy-java-selenium)