Update README.md

dropecho · Dec 3, 2023 · 7c1dd8c · 7c1dd8c
1 parent c4b215f
commit 7c1dd8c
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,16 @@ This library is a "wrapper" on buddy and utest.
 It allows you to use either one, but auto scan a testing directory and
 include those tests.
 
+## Usage
+Currently expects a folder struct like:
+
+test.hxml
+test/
+test/someFileTests.hx
+test/other/otherTests.hx
+
+test files must end in Tests to be discovered.
+
 ## TODO:
 
 finish writing the documentation.