From bbc90a67883307f2d3c66baeab7aeb2ee0b25069 Mon Sep 17 00:00:00 2001
From: helena <48861601+helenanull@users.noreply.github.com>
Date: Thu, 4 Mar 2021 22:03:51 +0200
Subject: [PATCH] Update README.md

---
 README.md | 28 +++++++++++++++++++---------
 1 file changed, 19 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index e6d0bb6..643b86a 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,12 @@
-# example tests using cypress __[and keeping it simple]__
+# Full E2E test suite with Cypress.io (for site:http://angularjs.realworld.io/) [WIP] 
+
+Goals:
+- keep it simple - no abstractions/functions/utils/helpers
+- tests are easily readable
+- project is easily understandable even to people without previous JS or Cypress knowledge
+
+![image](https://user-images.githubusercontent.com/48861601/110022516-af6f2400-7d34-11eb-8b13-f21789331cb3.png)
+
 
 # 1. Setup
 
@@ -21,17 +29,19 @@ cypress __headless mode__ (cypress run):
 
 # Information
 
-Goal is to have full E2E suite, that is easily understandable even to people without previous JS or Cypress knowledge.
-
 Tests are located in `cypress/integration` folder
 
 Configuration files:
-1. cypress.json
-2. plugins/index.js
+1. `cypress.json`
+2. `plugins/index.js`
 
 Custom commands (shortcuts) are located in `cypress/support` folder (`.cmd.js` suffix)
 
-Why mobile view is in config and not in test (like cy.viewport())?
+Selectors are located in `cypress/selectors` folder [only difference from cypress default project structure]
+- __not__ using page objects pattern but keeping selectors (only selectors) separately as they are not easily readable
+
+# Q&A
+1. Why mobile view is in config and not in test (like cy.viewport())?
 - we can't change userAgent in the middle of the test:
 https://github.com/cypress-io/cypress/issues/2100
 So it seems more correct to launch the tests with the correct config (--env device=mob/web)
@@ -39,6 +49,6 @@ So it seems more correct to launch the tests with the correct config (--env devi
 
 # __Following best practices__
 
-0. KISS [keep it simple, stupid]
-2. Using shortcuts to test only one feature at a time
-3. Tests are easily readable - __not__ using page objects pattern but keeping selectors (only selectors) separately as they are not easily readable
+1. https://www.youtube.com/watch?v=5XQOK0v_YRE&ab_channel=OKG%21
+2. https://docs.cypress.io/guides/references/best-practices.html
+3. https://docs.cypress.io/api/cypress-api/custom-commands.html#Best-Practices