From 8e18113546f15d80202ccb1c87e8493b700f66d2 Mon Sep 17 00:00:00 2001
From: David Johnston <david@blacksheepcode.com>
Date: Mon, 5 May 2025 13:17:41 +1000
Subject: [PATCH] Add documentation for async tests

---
 app/page.js | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/app/page.js b/app/page.js
index 5c73df6..19a8d65 100644
--- a/app/page.js
+++ b/app/page.js
@@ -5,6 +5,23 @@ export default function Home(props) {
   return (
     <>
     <Layout navState={{ about: true }}>
+      <div>
+        <strong>Async tests</strong>
+        <p>The async checkbox will provide a global function <code>deferred.resolve</code> which the test runner uses to determine that the test has finished.</p>
+        <p>Example usage:</p>
+        <pre>
+{`
+async function main() {
+  //your code here
+}
+
+(async function start(){
+  await main();
+  deferred.resolve();
+})()
+`}
+        </pre>
+      </div>
       <h1 className="font-semibold py-2">Create a test case</h1>
       <EditForm />
     </Layout>