Merge pull request #138 from osmestad/update-docs

Improve docs on how to get the test result details reported
hipstersmoothie · Oct 13, 2020 · 4f86cd2 · 4f86cd2
2 parents 17ac462 + e1c5477
commit 4f86cd2
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -33,9 +33,11 @@ Then just run jest and it will test errors PRs!
 ```
 
 ```sh
-jest file.js
+jest --testLocationInResults file.js
 ```
 
+(The `--testLocationInResults` flag is needed to get the in-file checks/annotations, otherwise only the summary comment is shown.)
+
 ## Using your own GitHub App
 
 You might not want to use our github app for the formatter.