Summary

The generic class used to contain all the sections, badges, histories and references.

Assembly

Rocket.Surgery.Nuke.dll

Namespace

Rocket.Surgery.Nuke.Readme

Base Types

graph BT Type-->Base0["Object"] Type["ReadmeUpdater"] class Type type-node

Syntax

public class ReadmeUpdater

Name	Summary
ReadmeUpdater()	Default constructor

Name	Value	Summary
Badges	Badges	The badges container
History	Histories	The history container
References	References	The references container for markdown references
Sections	Sections	The sections container

Name	Value	Summary
Process(string, IRocketBoosterBuild)	string	Updates the given markdown content with all the sections replaced. The "generated references" is special and will always be run through last, to make sure all sections can contribute references.

Name	Value	Summary
SetBackingValue<ReadmeUpdater, TV>(Expression<Func<ReadmeUpdater, TV>>, TV)	T	Sets the backing value. From ValueExtensions
With<ReadmeUpdater, TKey, TField>(Dictionary<TKey, TField>, IDictionary<TKey, TField>)	TBuilder	Adds the specified dictionary to the provided dictionary. From TestFixtureBuilderExtensions