From 69dafc3e509bba960360170bee9a966bda5e8786 Mon Sep 17 00:00:00 2001 From: brettlangdon Date: Mon, 13 Oct 2014 21:26:08 -0400 Subject: [PATCH] Add note on what gets searched for --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 95776bd..076864d 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,16 @@ for build in builds: Look for an appropriate `name` file or directory in the directory `directory` and parse all possible build configurations found. +`parse` defaults to looking for the following files: +* `.build.yml` +* `.build.yaml` +* `.build.json` +* `.build.ini` +* `.build.cfg` + +or for the directory `.build` which contains one or many configuration files +(name doesn't have to be "build"). + ## parse_directory(dir_name) *returns*: list