Add docs for the project and custom commands

M4deN · Sep 28, 2023 · 78fcca3 · 78fcca3
1 parent 88dc183
commit 78fcca3
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,5 +2,4 @@
 cypress.env.json
 cypress/downloads/
 cypress/screenshots/
-cypress/videos/
 node_modules/
diff --git a/README.md b/README.md
@@ -34,6 +34,8 @@ Run `npm test` (or `npm t` for short) to run all tests in headless mode using a
 
 Run `npm run test:tablet` to run the appropriate tests in headless mode using a tablet viewport.
 
+
+
 ### Interactive mode
 
 Run `npm run cy:open` to open the __Cypress App__ to run tests in interactive mode using a desktop viewport.
@@ -42,4 +44,18 @@ Run `npm run cy:open:tablet` to open the __Cypress App__ to run tests in interac
 
 ___
 
-Made with ❤️ by [Alecio L. Medeiros](https://github.com/M4deN).
+#### Example
+
+Here's an example of running all the tests in interactive mode.
+
+authenticated.cy.js
+
+login.cy.js
+
+signup.cy.js
+
+
+
+___
+
+Made with by [Alecio L. Medeiros](https://github.com/M4deN).
diff --git a/cypress/videos/authenticated.cy.js.mp4 b/cypress/videos/authenticated.cy.js.mp4
diff --git a/cypress/videos/login.cy.js.mp4 b/cypress/videos/login.cy.js.mp4
diff --git a/cypress/videos/signup.cy.js.mp4 b/cypress/videos/signup.cy.js.mp4
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "Testes-End-to-End-Cypress",
   "version": "1.0.0",
-  "description": "TBD.",
+  "description": "Sample project to demonstrate e2e tests written with Cypress running on GitHub Actions",
   "main": "cypress.config.js",
   "scripts": {
     "lint": "eslint cypress/**/*.js && eslint cypress.config.js",