Skip to content

Commit 6752fe5

Browse files
committed
chore: update README to reflect usage instructions and add dependency section; format report path in CI workflow
1 parent ca4ec21 commit 6752fe5

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

.github/workflows/main.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jobs:
3737
- name: Publish Test Results
3838
uses: ctrf-io/github-test-reporter@v1
3939
with:
40-
report-path: './ctrf/*.json'
40+
report-path: "./ctrf/*.json"
4141
github-report: true
4242
failed-report: true
4343
flaky-report: true
@@ -50,4 +50,3 @@ jobs:
5050
env:
5151
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5252
if: always()
53-

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,11 @@ Explore more <a href="https://www.ctrf.io/integrations">integrations</a>
2727
</p>
2828
</div>
2929

30-
## Installation
30+
## Usage
31+
32+
This package can be used via the CLI or added as a dependency to your project.
33+
34+
## Dependency
3135

3236
```sh
3337
npm install [email protected]
@@ -39,7 +43,7 @@ import { convertJUnitToCTRFReport } from "junit-to-ctrf";
3943
const report = await convertJUnitToCTRFReport("path/to/junit.xml");
4044
```
4145

42-
## API reference
46+
### API reference
4347

4448
See [API reference](./docs) for more details.
4549

0 commit comments

Comments
 (0)