Skip to content

Commit

Permalink
docs: Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mikestreety authored Oct 1, 2024
1 parent 5ca63b0 commit f8b55de
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ This is a wrapper/meta framework around [Playwright](https://playwright.dev/) -
## Naming Conventions

- `*.unit.ts` - These are unit tests and should not open the browser - they are only run by the first device
- `*.spec.ts` - These should test functionality and open the browser - they are only run by the first device
- `*.unit.ts` - These are unit tests and should **not** open the browser - they are **only** run by the first device
- `*.spec.ts` - These should test functionality and open the browser - they are **only** run by the first device
- `*.test.ts` - These should be used for end-to-end testing and are run by all the devices specified

## Get Started
Expand All @@ -21,6 +21,9 @@ npm i @liquidlight/playwright-framework -D --save

### Playwright Config

> [!TIP]
> If you are running a TYPO3 site, it's worth checking out the [Liquid Light Playwright Framework TYPO3 documentation](./docs/5-typo3.md).
Create a `playwright.config.ts` with the following contents:

```typescript
Expand All @@ -44,7 +47,7 @@ const config = require('@liquidlight/playwright-framework')([
- Everything passed into the `project` object inside the site will be passed directly to each [project](https://playwright.dev/docs/test-projects)
- If you pass `devices` as an array of strings, a project will be made per device (or you can not use any device by passing an empty array)

More details on how the configuration works can be found [in the docs](./docs/2-configuration.md). If you are running a TYPO3 site, it's worth checking out the [Liquid Light Playwright Framework TYPO3 documentation](./docs/5-typo3.md).
More details on how the configuration works can be found [in the docs](./docs/2-configuration.md).

> [!TIP]
> By setting local & production domains (and other), the framework can use these domains for your tests without needing to specify the full URL
Expand Down

0 comments on commit f8b55de

Please sign in to comment.