projen/lib/readme.d.ts

CDK for software projects

import { Project } from "./project";
import { SampleFile } from "./sample-file";
/**
 * SampleReadme Properties
 */
export interface SampleReadmeProps {
    /**
     * The name of the README.md file
     *
     * @default "README.md"
     * @example "readme.md"
     */
    readonly filename?: string;
    /**
     * The contents
     * @default "# replace this"
     */
    readonly contents?: string;
}
/**
 * Represents a README.md sample file.
 * You are expected to manage this file after creation.
 *
 * @param text - The initial contents of the README.md file. Defaults to '# replace this'
 */
export declare class SampleReadme extends SampleFile {
    constructor(project: Project, props?: SampleReadmeProps);
}