Skip to content

Commit d74c1dc

Browse files
committed
docs: update the README
1 parent d65b821 commit d74c1dc

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
- [x] Github Actions workflow for linting and testing.
1515
- [x] Clear community files like [CONTRIBUTING.md](https://github.com/pluginpal/strapi-plugin-boilerplate/blob/main/CONTRIBUTING.md) and [CODE-OF-CONDUCT.md](https://github.com/pluginpal/strapi-plugin-boilerplate/blob/main/CODE_OF_CONDUCT.md).
1616
- [x] Jest & Supertest for testing your plugin API's.
17-
- [ ] Cypress for GUI e2e tests
17+
- [x] Cypress for GUI e2e tests
1818

1919
## ⏳ How to use
2020

@@ -65,22 +65,25 @@ To better understand how and why this repository has been setup, please read the
6565
7. `yarn test:jest`
6666
- Runs the jest tests. Can contain unit & integration tests.
6767
- Used in the test step of the pipeline.
68+
8. `yarn test:cypress`
69+
- Runs the cypress tests. Contains e2e tests.
70+
- Used in the test step of the pipeline.
6871

6972
### Playground commands
7073

71-
8. `yarn playground:install`
74+
9. `yarn playground:install`
7275
- Installs the plugin into the playground using `yalc-add-link`.
7376
- Installs all other dependencies of the playground.
74-
9. `yarn playground:yalc-add`
77+
10. `yarn playground:yalc-add`
7578
- Installs a production-like version of the plugin, into the playground.
76-
10. `yarn playground:yalc-add-link`
79+
11. `yarn playground:yalc-add-link`
7780
- Installs a development build of the plugin, into the playground.
78-
11. `yarn playground:build`
81+
12. `yarn playground:build`
7982
- The native Strapi build command, ran in the playground.
8083
- [Documentation can be found here](https://docs.strapi.io/dev-docs/cli).
81-
12. `yarn playground:develop`
84+
13. `yarn playground:develop`
8285
- The native Strapi develop command, ran in the playground.
8386
- [Documentation can be found here](https://docs.strapi.io/dev-docs/cli).
84-
13. `yarn playground:start`
87+
14. `yarn playground:start`
8588
- The native Strapi start command, ran in the playground.
8689
- [Documentation can be found here](https://docs.strapi.io/dev-docs/cli).

0 commit comments

Comments
 (0)