Skip to content

Commit 0cc9779

Browse files
committed
Document async export
1 parent 0f03e57 commit 0cc9779

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ and run the `curator` command to install the configuration.
7272
7373
- The manifest configuration is defined below.
7474
Copy the example manifest from [`manifest.example.js`](./manifest.example.js).
75+
- The manifest should be the default export and may be an object, function,
76+
promise, or async function.
7577
- The location of the manifest file may be passed as the first argument,
7678
otherwise it looks for `manifest.js` in the current working directory.
7779
- The environment variables `CURATOR_IO` and `CURATOR_PKG` may be set
@@ -302,6 +304,8 @@ const symlinks = [{
302304
}]
303305

304306
/* Export each value set above.
307+
* The export may be a plain object as below, or a function, promise,
308+
* or async function that returns the plain object.
305309
* Simply do not export an option to use the default.
306310
*/
307311
module.exports = {

0 commit comments

Comments
 (0)