@pumpkin-plugins/docs API / node / generateRootReadme

Function: generateRootReadme()

generateRootReadme(root, check?): Promise<Status>

Defined in: tools/docs/src/node.ts:263

Refreshes the actions, plugin and tool tables in the repo's root README.

Parameters

root

string

The repository root.

check?

boolean = false

Only report whether the README is out of date, without writing.

Returns

Promise<Status>

What happened to the README.

Throws

When the README or its packages block is missing.