From a7aa0cc292343e6a899ce8668c19f1d9a96e8259 Mon Sep 17 00:00:00 2001 From: Brad Simpson Date: Wed, 27 Sep 2023 10:44:35 -0600 Subject: [PATCH] Readme updates --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4aef99a..d081d35 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,14 @@ * failed * passed -The 'incomplete' image is only needed if the Assessment Results Graphic can been seen by the learner prior to assessment completion i.e. it hasn't been hidden either by the Trickle extension or by using `_isVisibleBeforeCompletion: false` - otherwise it can safely be left out. +The `_assessmentIncomplete` image is only needed if the Assessment Results Graphic can been seen by the learner prior to assessment completion (i.e. it hasn't been hidden either by the Trickle extension or by using `_isVisibleBeforeCompletion: false`). Otherwise, it can safely be left out. -You *must* specify both the failed and passed images. If you don't want to have a different graphic for each of those assessment states you should probably just be using the standard graphic component..! +You *must* specify both the failed and passed images (`_assessmentFailed` and `_assessmentPassed`). If you don't want to have a different graphic for each of those assessment states, you should probably just be using the standard Graphic component. -It is expected that most of the time this component will have `_isOptional: true` - but if not, it does support the same `_setCompletionOn` settings as the Assessment Results component. +It is expected that most of the time this component will have `_isOptional: true`. If it is _not_ optional, it does support the same `_setCompletionOn` settings as the Assessment Results component. ## Limitations -Hasn't yet had a properties.schema added and set up - so isn't Adapt Authoring Tool compatible. +Hasn't yet had schemas added and set up, so it isn't Adapt Authoring Tool compatible. ---------------------------- **Framework versions:** 5+