From ea7d2fb0895fec6c555e1e5071ef1f2003b8fa43 Mon Sep 17 00:00:00 2001 From: Conor Nosal Date: Sun, 12 Jan 2020 15:19:43 -0500 Subject: [PATCH] note differentiating processor features in readme --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ee6c1c7..4180ae5 100644 --- a/README.md +++ b/README.md @@ -290,7 +290,7 @@ interpolator: See [bosh interpolate](https://bosh.io/docs/cli-int/) and [variable types](https://bosh.io/docs/variable-types/) for more details ### processor options -A snippet can override the libraries processor type, or provide options +A snippet can override the library's default processor type, or provide options #### opsfile processor ``` @@ -300,11 +300,13 @@ options: ``` See the [go-patch](https://github.com/cppforlife/go-patch) and [ops-file](https://bosh.io/docs/cli-ops-files) docs for more details +Differentiating features: field matching and index selection + #### yq processor ``` type: yq options: - command: # write, read, delete, prefix, merge + command: # write, read, delete, prefix, merge (default write) path: # yaml element to read or delete prefix: # key to nest the current yaml structure under overwrite: # boolean for merges to replace existing elements @@ -312,6 +314,8 @@ options: ``` See the [yq docs](https://mikefarah.github.io/yq/) for more details +Differentiating features: wildcards, prefix, and merge + ## Invocation Running `manifer compose --library mainlib.yml --template foo-template.yml --scenario my-use-case` should produce: ```