Skip to content

Commit

Permalink
docs: update readme to reflect implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
adthrasher committed Feb 4, 2025
1 parent f865d05 commit eb4b23d
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ Validates an input JSON against a task or workflow input schema.

#### wdl_file

A WDL document containing a task or workflow for which to check inputs.
A comma-separated list of WDL documents containing a task or workflow for which to check inputs.

#### inputs_file

A JSON format inputs file for the task or workflow.
A matching comma-separated list of JSON format inputs file for the task(s)/workflow(s). Ordering must match `wdl_file` as no checking will be performed.

### Example usage

Expand All @@ -76,6 +76,15 @@ with:
inputs_file: "inputs/bwa.json"
```

Multiple files can be specified as well.
```yaml
uses: stjude-rust-labs/sprocket-action@main
with:
action: validate-inputs
wdl_file: "tools/bwa.wdl,tools/star.wdl"
inputs_file: "inputs/bwa.json,inputs/star.wdl"
```

## License and Legal

This project is licensed as either [Apache 2.0][license-apache] or
Expand Down

0 comments on commit eb4b23d

Please sign in to comment.