diff --git a/README.md b/README.md index 0a828a5671e02a93ae974eafb8a266e895305b5c..bb887e2878bac157adfec04d299aebd8d103a9b1 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