Class Types
| Class | Summary |
|---|---|
| Badges | A container for badges that you want to show on the readme |
| Histories | A container for build histories that you want to show on the readme |
| ReadmeUpdater | The generic class used to contain all the sections, badges, histories and references. |
| References | This section is used to allow for clean markdown references so that the readme file isn't complete cluttered with image urls and links. |
| Sections | A general sections container, used to replace sections in the markdown |
Interface Types
| Interface | Summary |
|---|---|
| IBadgeSection | Interface is used to add another badge to the `badges` container in the readme. |
| IHistorySection | Interface is used to add another badge to the `history badges` container in the readme. |
| IMarkdownReferences | A container interface for markdown references `[somekey]: somevalue "some alt text"` |
| IReadmeSection | Interface is used to add a custom section that will be replaced in the readme with markdown content |