craft-hub / readProjectReadme

Function: readProjectReadme()

readProjectReadme(projectRoot, commandPackage): Promise<ProjectReadme>

Defined in: packages/craft-hub/src/project-overview.ts:141

Resolve and read one bounded UTF-8 README without exposing arbitrary filesystem access.

Parameters

projectRoot

string

commandPackage

CommandPackage

Returns

Promise<ProjectReadme>