From 126568d7bddcb0696a3a4202030b240866a41889 Mon Sep 17 00:00:00 2001
From: wolf99 <281700+wolf99@users.noreply.github.com>
Date: Tue, 13 Oct 2020 12:42:46 +0100
Subject: [PATCH] Add scenarios to example and describe purpose (#1683)

---
 README.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/README.md b/README.md
index d00a78c258..f4880e71be 100644
--- a/README.md
+++ b/README.md
@@ -115,6 +115,7 @@ The file format is described in [canonical-schema.json](./canonical-schema.json)
                 "word"       : "28948022309329048855892746252171976962977213799489202546401021394546514198529"
               }
             , "expected"   : null
+            , "scenarios"  : [ "big-integers" ]
             }
           , { "uuid"       : "c7b6f24a-553f-475a-8a40-dba854fe1bff"
             , "description": "Bar'ing a name with numbers gives an error"
@@ -133,6 +134,8 @@ The file format is described in [canonical-schema.json](./canonical-schema.json)
 
 ## Scenarios
 
+An optional field to allow for selectively including/excluding test cases based on a property of the test case (such as using big integers).
+
 - The `scenarios` field can use one or more of a predefined set of values, which are defined in a [`SCENARIOS.txt`](./SCENARIOS.txt) file.
 - The `scenarios` field can be mutated additively, by adding new scenarios. Existing scenarios must not be changed or removed. Adding new scenarios does therefore does not mean adding a new test case.
 - Library tests should have a `library-test` scenario added to allow for easy including/excluding of library tests. Application tests won't have their own scenario, as they must be included and should not be filtered on.