Skip to content
This repository has been archived by the owner on Mar 27, 2023. It is now read-only.

Commit

Permalink
Add more descriptive documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jbutcher5 committed Jul 30, 2021
1 parent e755edb commit 3b765e4
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,12 @@ Data read from YAML file.

## Example usage

``` yaml
name: Read YAML Data
uses: KJ002/read-yaml@v1.3
id: yaml-data
with:
file: './file-to-read.yaml'
key-path: '["key-to-read"]'
file: './action.yaml'
key-path: '["runs", "using"]' # Access the runs key then the using key and retuns the value.
```

0 comments on commit 3b765e4

Please sign in to comment.