From def81a2588d2c520961b57198e0038be66f40a21 Mon Sep 17 00:00:00 2001
From: Michael Fairchild <mfairchild365@gmail.com>
Date: Wed, 3 Sep 2014 12:03:03 -0500
Subject: [PATCH] Update readme with sections for testing and expectations

---
 README.md | 30 +++++++++++++++++++++++-------
 1 file changed, 23 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 0a828a5..bb887e2 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,23 @@
-PURPOSE
---------
-Proxies UNL Alerts issued from external vendor applications so they can be distributed in CAP format.
-
-SETUP
------
-1. Copy configsample.inc.php to config.inc.php
+PURPOSE
+--------
+Proxies UNL Alerts issued from external vendor applications so they can be distributed in CAP format.
+
+SETUP
+-----
+1. Copy configsample.inc.php to config.inc.php
+2. 
+
+Expections
+-----
+TODO: document how the application is expected to work and communicate with the UNLedu framework and other systems
+
+Automated Testing
+-----
+Run automated tests via this command `TODO: fill in once suite has been created`
+
+Manual Testing
+-----
+TODO: Describe process to set up a test server with a test alert and how to test it with the UNLedu framework.
+* Ensure that polling is working
+* Ensure that the alert does not re-open
+*
\ No newline at end of file
-- 
GitLab