README.md in coursemology-evaluator-0.1.4 vs README.md in coursemology-evaluator-0.1.6

- old
+ new

@@ -25,5 +25,28 @@ 1. You might need to configure a new user on your Coursemology instance, enable token authentication, and grant the `auto_grader` system/instance permission. 3. Start the evaluator using the Procfile. You can use [foreman](https://github.com/ddollar/foreman) or any similar tool to generate system scripts for boot. + +### Command Line Options + +#### Compulsory Options + +1. `--host`: Coursemology host to connect to +2. `--api-user-email`: User with autograder flag set +3. `--api-token`: Authentication token of the user + +#### Optional Options + +Time options are expected to be strings in [ISO8601 format](https://en.wikipedia.org/wiki/ISO_8601#Durations). + +1. `--interval`: Time interval between checks for programming allocations. As this time is + expected to be short, specify it with the time components of ISO8601 only. (Hours, minutes, seconds) + The time designator `T` must be left out. + +2. `--lifetime`: Length of time to cache Docker images. This is expected to be in the order of days. + If more granularity is needed, the time designator is required. + + E.g. `1DT2H5M10S` + +3. `--one-shot`: Runs once and terminates. Primarily used for testing.