craft-hub / readPackageDocument

Function: readPackageDocument()

readPackageDocument(packageRoot, requestedPath?): Promise<ProjectReadme>

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

Resolve and read one bounded UTF-8 Markdown document inside a package root.

Parameters

packageRoot

string

requestedPath?

string

Returns

Promise<ProjectReadme>