diff --git a/README.md b/README.md index a845177..c8804ba 100644 --- a/README.md +++ b/README.md @@ -2,35 +2,12 @@ A framework of sensible config & utilises for use with [Playwright](https://playwright.dev/). -ESM and CJS compatible; this framework offers dynamic URL and test matching, sensible default (with Monocart preconfigured) along with TYPO3 related enhancements. +ESM and CommonJS compatible; this framework offers dynamic URLs/Hosts, dynamic test matching, sensible default (with Monocart preconfigured) along with TYPO3 related enhancements. -**[View the documentation](https://liquidlight.github.io/playwright-framework/)** +### [📚 View the documentation](https://liquidlight.github.io/playwright-framework/) Legacy installations can find the relevant documentation on the tags: +- [main](https://github.com/liquidlight/playwright-framework/tree/main) for ESM & CommonJS - [1.1.0](https://github.com/liquidlight/playwright-framework/tree/1.1.0) for ESM - [0.4.0-beta.1](https://github.com/liquidlight/playwright-framework/tree/0.4.0-beta.1) for CommonJS - -## Framework development - -### Releasing this Playwright Framework - -When it comes to creating a new release for the Playwright Framework, run the following: - -1. `npx eslint .` and `npx eslint . --fix` -2. `npm run build` -3. Update the version number in `package.json` -4. Commit result -5. `git tag [version]` -6. `git push origin main --tags` - this will publish to NPM - -### Local Development of the Playwright Framework - -1. Clone the repository down parallel to your project -2. Run `npm install` -2. Run `npm run pack` -3. In your project, delete `node_modules/@liquidlight/playwright-framework` -4. Update the `package.json` in the project to be `"@liquidlight/playwright-framework": "file:./../playwright-framework/liquidlight-playwright-framework-0.4.0-beta.1.tgz"` (or whatever the tgz file made is) -5. Run `npm update` in the project - -If you make changes to the package, run `npm run pack` in the package and `npm update` in the project diff --git a/docs/framework-development.md b/docs/framework-development.md new file mode 100644 index 0000000..8f253d9 --- /dev/null +++ b/docs/framework-development.md @@ -0,0 +1,28 @@ +--- +title: Framework Development +nav_order: 3 +--- + +# Framework Development + +## Releasing this Playwright Framework + +When it comes to creating a new release for the Playwright Framework, run the following: + +1. `npx eslint .` and `npx eslint . --fix` +2. `npm run build` +3. Update the version number in `package.json` +4. Commit result +5. `git tag [version]` +6. `git push origin main --tags` - this will publish to NPM + +## Local Development of the Playwright Framework + +1. Clone the repository down parallel to your project +2. Run `npm install` +2. Run `npm run pack` +3. In your project, delete `node_modules/@liquidlight/playwright-framework` +4. Update the `package.json` in the project to be `"@liquidlight/playwright-framework": "file:./../playwright-framework/liquidlight-playwright-framework-0.4.0-beta.1.tgz"` (or whatever the tgz file made is) +5. Run `npm update` in the project + +If you make changes to the package, run `npm run pack` in the package and `npm update` in the project