From 2746dbdb63bc06dc40a5ad1c56dfdd4257f798d1 Mon Sep 17 00:00:00 2001
From: James <inbox.dev@jhodges.co.uk>
Date: Sun, 22 Sep 2019 09:04:50 +0100
Subject: [PATCH] better comments and readme

---
 README.md                  | 11 +++++++++++
 src/BrowserTest.php        |  5 +++++
 src/DomainRedirectTest.php |  5 +++++
 src/UrlRedirectTest.php    |  5 +++++
 4 files changed, 26 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..148beb9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+The base (abstract) classes for my PHPUnit testing scripts.
+
+## BrowserTest.php
+Set up the Selenium test using args from environment
+Take a screenshot on failed test
+
+## DomainRedirectTest.php
+This will test all combinations of http/https/www/trailing slash, checking that they all redirect to the same destination URL.
+
+## UrlRedirectTest.php
+This will check (using curl) that the source URL redirects to the destination URL
diff --git a/src/BrowserTest.php b/src/BrowserTest.php
index 8761062..bbebeb3 100644
--- a/src/BrowserTest.php
+++ b/src/BrowserTest.php
@@ -1,6 +1,11 @@
 <?php
 namespace JHodges\PHPUnitBase;
 
+/**
+* Set up the Selenium test using args from environment
+* Take a screenshot on failed test
+**/
+
 abstract class BrowserTest extends \PHPUnit_Extensions_Selenium2TestCase{
 
   public function setUp(){
diff --git a/src/DomainRedirectTest.php b/src/DomainRedirectTest.php
index df6bf85..5b75876 100644
--- a/src/DomainRedirectTest.php
+++ b/src/DomainRedirectTest.php
@@ -1,6 +1,11 @@
 <?php
 namespace JHodges\PHPUnitBase;
 
+/**
+* This will test all combinations of http/https/www/trailing slash.
+* Checking that they all redirect to the same destination URL.
+**/
+
 abstract class DomainRedirectTest extends UrlRedirectTest{
 
 	/**
diff --git a/src/UrlRedirectTest.php b/src/UrlRedirectTest.php
index 037f08b..45d4110 100644
--- a/src/UrlRedirectTest.php
+++ b/src/UrlRedirectTest.php
@@ -3,6 +3,11 @@ namespace JHodges\PHPUnitBase;
 
 use \PHPUnit\Framework\TestCase;
 
+/**
+* This will check (using curl) that the source
+* URL redirects to the destination URL
+**/
+
 abstract class UrlRedirectTest extends TestCase{
 
 	/**