chore: add clarification around E2E README (#149)

JamesLMilner · Dec 23, 2023 · f18a2aa · f18a2aa
1 parent e017e15
commit f18a2aa
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/e2e/README.md b/e2e/README.md
@@ -1,6 +1,6 @@
 # E2E Testing with Playwright
 
-We provide a basic end-to-end (E2E) via Playwright, testing against the Leaflet Adapter
+We provide a basic end-to-end (E2E) test suite via Playwright, testing against the Leaflet Adapter. The test suite aims to emulate how an end user would interact with and use Terra Draw. Here we can attempt to catch bugs earlier in the pipeline and ensure that new behaviours in the future adhere to a given specification. 
 
 ## Installation
 
@@ -23,3 +23,7 @@ Or you can run them headed (i.e. Chromimum will open and you will see the tests
 ```shell
 npm run test:headed
 ```
+
+## Tests
+
+Tests are located in the `tests` folder. You will see the `leaflet.spec.ts` file, this is where the tests are kept for the E2E tests written for the Leaflet Adapter. There are also some convienence methods written in the `setup.ts` file which can be leveraged to write tests more easily.