Class: ReadMe

jsdoc/readme~ReadMe()

Represents a README file.

jsdoc/readme~ReadMe(path)

jsdoc/readme~ReadMe(path)

Represents a README file.

Constructor

new ReadMe(path)

Parameters:
Name Type Description
path string The filepath to the README.
Source:

Members

html

Source: