Skip to content

Commit

Permalink
Document async export
Browse files Browse the repository at this point in the history
  • Loading branch information
razor-x committed Nov 20, 2020
1 parent 0f03e57 commit 0cc9779
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 = {
Expand Down

0 comments on commit 0cc9779

Please sign in to comment.