From 0cc97790cc8ff7cfd675dda7bb5543307ca75779 Mon Sep 17 00:00:00 2001 From: Evan Sosenko Date: Thu, 19 Nov 2020 17:14:30 -0800 Subject: [PATCH] Document async export --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 40a0a1e..2edaf98 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,8 @@ and run the `curator` command to install the configuration. - The manifest configuration is defined below. Copy the example manifest from [`manifest.example.js`](./manifest.example.js). +- The manifest should be the default export and may be an object, function, + promise, or async function. - The location of the manifest file may be passed as the first argument, otherwise it looks for `manifest.js` in the current working directory. - The environment variables `CURATOR_IO` and `CURATOR_PKG` may be set @@ -302,6 +304,8 @@ const symlinks = [{ }] /* Export each value set above. + * The export may be a plain object as below, or a function, promise, + * or async function that returns the plain object. * Simply do not export an option to use the default. */ module.exports = {