2020-05-11 11:33:34 +02:00

34 lines
523 B
TypeScript

/* eslint-disable max-len */
export function get_readme (
software: string,
description: string,
dev: boolean,
license: string,
author: string
): string {
return `# ${software}
[![Package quality](https://packagequality.com/shield/${software}.svg)](https://packagequality.com/#?package=${software})
> ${description}
## Installation
npm:
> npm i --save${dev ? '-dev' : ''} ${software}
yarn:
> yarn add ${dev ? '--dev' : ''} ${software}
## Usage
TODO: Add usage
## License
${license} © ${author}
`;
}