API Reference
Class
ReadmeOptions
Options for README scaffolding.
Inheritance
- Object
- ReadmeOptions
Constructors
public ReadmeOptions(String projectName) #Create options for project.
Parameters
- projectName System.String
Methods
public ReadmeOptions Badges(Action<BadgeBuilder> build) #Returns:
ReadmeOptionsAdds badges via builder.
Parameters
- build System.Action{OfficeIMO.Markdown.BadgeBuilder}
public ReadmeOptions Description(String description) #Returns:
ReadmeOptionsSets the README description paragraph.
Parameters
- description System.String
public ReadmeOptions GettingStarted(String installCommand, String codeBlock) #Returns:
ReadmeOptionsSets install command and getting-started code snippet.
Parameters
- installCommand System.String
- codeBlock System.String
public ReadmeOptions Links(params ValueTuple<String, String>[] links) #Returns:
ReadmeOptionsAdds links section entries.
Parameters
- links System.ValueTuple{System.String,System.String}[]
public ReadmeOptions NuGet(String packageId) #Returns:
ReadmeOptionsSets the NuGet package id.
Parameters
- packageId System.String
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object