From 4383d92fb6ff84e1ab5fa1a67a46170f7655cb28 Mon Sep 17 00:00:00 2001 From: "Anders D. Johnson" Date: Sun, 4 Mar 2018 10:12:47 -0600 Subject: [PATCH] docs: fix config file name, note arrays for ignore --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 091ecdb..bb718fe 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ yamllint test.yaml YAML Lint is configured using the following options via a configuration file, environment variables, and/or command-line arguments. -First of all, YAML Lint looks for a JSON file called `yaml-lint.json` within the current working directory. +First of all, YAML Lint looks for a JSON file called `.yaml-lint.json` within the current working directory. ```json { @@ -72,7 +72,7 @@ yamllint --schema=CORE_SCHEMA --ignore=dir/*.yaml - `CORE_SCHEMA` Same as `JSON_SCHEMA` ([http://www.yaml.org/spec/1.2/spec.html#id2804923](http://www.yaml.org/spec/1.2/spec.html#id2804923)) - `DEFAULT_SAFE_SCHEMA` All supported YAML types, without unsafe ones (`!!js/undefined`, `!!js/regexp`, and `!!js/function`) ([http://yaml.org/type/](http://yaml.org/type/)) -### `ignore` (string) +### `ignore` (string or array of strings) > Specifies one or multiple glob patterns to ignore