Skip to content

Commit fa6ff22

Browse files
docs: update cypress-commands README (#4335)
Co-authored-by: Marcus Notheis <[email protected]>
1 parent 6d3d2e9 commit fa6ff22

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

packages/cypress-commands/README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,27 @@
1-
todo
1+
# @ui5/webcomponents-cypress-commands
2+
3+
> This package is a work-in-progress and can be extended by you! If you feel like a command or query is missing, please
4+
> feel free to open a PR adding it to our library. Contributions are always welcome!"
5+
6+
Since testing web components is sometimes not as straightforward as one would like it to be, we offer a package with a set of commands and queries to make it easier to interact with them:
7+
8+
## Installation
9+
10+
```sh
11+
npm install @ui5/webcomponents-cypress-commands
12+
```
13+
14+
After the installation you can import it in your entry file (e.g. `component.ts`):
15+
16+
```ts
17+
import '@ui5/webcomponents-cypress-commands';
18+
```
19+
20+
Now you can use all commands and queries that are available in this package.
21+
22+
> You can find a detailed description of all available commands and queries [here](https://sap.github.io/ui5-webcomponents-react/?path=/docs/testing-with-cypress-setup--docs)
23+
24+
## License
25+
26+
Please see our [LICENSE](https://github.com/SAP/ui5-webcomponents-react/blob/main/LICENSE) for copyright and license information.
27+
Detailed information including third-party components and their licensing/copyright information is available via the [REUSE tool](https://api.reuse.software/info/github.com/SAP/ui5-webcomponents-react).

0 commit comments

Comments
 (0)