Skip to content

Commit f79ef59

Browse files
committed
docs: what is this?
Signed-off-by: Lexus Drumgold <[email protected]>
1 parent de10010 commit f79ef59

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[![conventional commits](https://img.shields.io/badge/-conventional%20commits-fe5196?logo=conventional-commits\&logoColor=ffffff)](https://conventionalcommits.org)
88
[![yarn](https://img.shields.io/badge/-yarn-2c8ebb?style=flat\&logo=yarn\&logoColor=ffffff)](https://yarnpkg.com)
99

10-
Execute JSON queries in GitHub Actions
10+
A [`jq`][jq] utility for GitHub Actions
1111

1212
## Contents
1313

@@ -23,7 +23,7 @@ Execute JSON queries in GitHub Actions
2323

2424
## What is this?
2525

26-
**TODO**: what is this?
26+
This is a simple, but useful action for executing JSON queries with [`jq`][jq].
2727

2828
## Use
2929

@@ -46,18 +46,20 @@ For more advanced filters, see <https://jqlang.github.io/jq/manual>.
4646

4747
The command options to apply.
4848

49-
The raw output option, `-r`, will be prepended. With this option, if result of the [`filter`](#filter) is a string, it
50-
will be written directly to standard output rather than being formatted as a JSON string with escapes and quotes.
49+
The raw output option, `-r`, will be prepended. With this option, if the result of the [`filter`](#filter) is a string,
50+
it will be written directly to standard output rather than being formatted as a JSON string with escapes and quotes.
5151

5252
## Outputs
5353

5454
### `result`
5555

56-
The result of the operation.
56+
The result of the [`filter`](#filter).
5757

5858
## Contribute
5959

6060
See [`CONTRIBUTING.md`](CONTRIBUTING.md).
6161

6262
This project has a [code of conduct](./CODE_OF_CONDUCT.md). By interacting with this repository, organization, or
6363
community you agree to abide by its terms.
64+
65+
[jq]: https://jqlang.github.io/jq

0 commit comments

Comments
 (0)