diff --git a/README.md b/README.md index 8a81083..1789a0e 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ -## Description +# PASS Acceptance Testing ![PASS Acceptance Testing](https://github.com/eclipse-pass/pass-acceptance-testing/actions/workflows/test.yml/badge.svg) -Acceptance / smoke tests for the [PASS application](https://github.com/eclipse-pass). This repository will use [TestCafe](https://testcafe.io/) to define smoke tests that can run against an instance of PASS. +PASS Acceptance Testing is a suite of acceptance and smoke tests for the [PASS application](https://github.com/eclipse-pass). +It utilizes [TestCafe](https://testcafe.io/) to define tests to be run against an instance of PASS. -## Running Tests +A full list of all the Eclipse PASS projects can be found in the PASS Main repository [README](https://github.com/eclipse-pass/main). -`yarn run test` - runs the acceptance tests against a locally running pass-docker +# Guides -`yarn run testDeployment` - runs the acceptance tests against a deployed PASS system such as stage or prod. Please see the `rundeploymenttest.sh` file for required environment variables. +* [PASS Acceptance Testing](https://docs.eclipse-pass.org/developer-documentation/pass-acceptance-testing) +* [PASS Documentation](https://docs.eclipse-pass.org/) -## Prerequisites +# License -* [NodeJS](https://nodejs.org/en/) version 14+ -* [Yarn](https://yarnpkg.com/) v1.x - package manager, similar to NPM +PASS Acceptance Testing is Open Source software released under the [Apache 2.0 license](LICENSE). \ No newline at end of file