Skip to content

Commit b0a7d7b

Browse files
authored
Update readme with instructions (#3)
Update readme with instructions
2 parents 68a8d51 + f7fb5f6 commit b0a7d7b

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,25 @@
11
## testbox-codewars
22

3-
- `CodewarsReporter`: Custom reporter for TestBox to produce Codewars format
4-
- `TestRunner`: Runs TestBox tests and produces output for Codewars
3+
- `CodewarsReporter.cfc`: Custom reporter for TestBox to produce Codewars format
4+
- `TestRunner.cfc`: Runs TestBox tests and produces output for Codewars
5+
- `CodewarsBaseSpec.cfc`: Base tests for CFML test bundles that captures spec-level debugging output
56

67
### Usage
78

9+
Assumes you have CommandBox CLI installed and in your path:
10+
11+
https://commandbox.ortusbooks.com/setup/installation
12+
13+
Make sure TestBox is installed:
14+
15+
```bash
16+
box install
817
```
18+
19+
To test locally, create a `Solution.cfc` and `SolutionTest.cfc` in the root dir.
20+
21+
Run the task runner with the following command:
22+
23+
```bash
924
box task run TestRunner
1025
```

0 commit comments

Comments
 (0)