as_readme_text

Warning

🚧 Sprout is still in active development and evolving quickly, so the documentation and functionality may not work as described and could undergo substantial changes 🚧

as_readme_text(properties: PackageProperties)

Creates a string containing the README text based on the properties.

Using a template, this will build a README file with the contents of the properties object in a human-readable format. Use write_file() to save the text to the README.md file.

Parameters

properties : PackageProperties

An object containing the package and resource properties.

Returns

str

A string with the README text based on the properties.