README.md in fluent-plugin-jq-0.4.0 vs README.md in fluent-plugin-jq-0.5.0
- old
+ new
@@ -11,11 +11,11 @@
## Installation
See also: [Plugin Management](https://docs.fluentd.org/v1.0/articles/plugin-management).
-Before you install this plugin, please make sure that `libjq` has been installed on your machine. For example, it's called `jq-dev` on alpine linux; while on debian, and ubuntu, you will find it as the `libjq-dev` package.
+Before you install this plugin, please make sure the `jq` command line tool has been installed on your machine. Plugins defined in this gem will call the `jq` command to make the transformation.
### RubyGems
```
$ gem install fluent-plugin-jq
@@ -71,10 +71,10 @@
This must be `jq`.
##### jq (string) (required)
-The jq filter for formatting income events. The result of the program should only return one item of any kind (a string, an array, an object, etc.). If it returns multiple items, only the first will be used.
+The jq filter for formatting income events. The returned result should be a string, if not, it will be encoded to a JSON representation in a string.
##### on_error (enum) (optional)
Defines the behavior on error happens when formatting an event. "skip" will skip the event; "ignore" will ignore the error and return the JSON representation of the original event; "raise_error" will raise a RuntimeError.