Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Improved readme and test instructions for flowManager

  • Loading branch information...
commit 8ff05ce1e28485467655329088b962e4c7a34f90 1 parent 38b5534
@amb26 authored
Showing with 8 additions and 6 deletions.
  1. +8 −6 gpii/node_modules/flowManager/README.md
View
14 gpii/node_modules/flowManager/README.md
@@ -1,16 +1,16 @@
Flow Manager
===
-Flow manager is responsible for the following:
+The flow manager is responsible for the overall orchestration of the various subcomponents which comprise the GPII personalization architecture. It:
- is able to be notified by the user listener.
-- queries preferences server for user preferences.
-- queries solutions reporter for available solutions.
+- queries the preferences server for user preferences.
+- queries the solutions reporter for available solutions.
- communicates with the matchmaker.
- communicates with the launch manager.
---
-Calls to preferences server are made with user credentials.
+Calls to the preferences server are made with user credentials.
### Dependencies
@@ -19,6 +19,8 @@ Calls to preferences server are made with user credentials.
### Run
-To run flow manager independantly, please use testDriver module within univeral repository. Simply run (from unveral root):
+To test the flow manager independently, please use testDriver module within universal repository. Simply run (from universal root):
- node gpii/node_modules/testDriver/src/TestDriver.js
+ node gpii/node_modules/testDriver/src/TestDriver.js
+
+Note that the overall "universal" root repository must itself appear in the node modules lookup path. This can most easily be achieved by checking it out into a directory named "node_modules" at the higher level.
Please sign in to comment.
Something went wrong with that request. Please try again.