2020-05-11 11:33:34 +02:00
|
|
|
/* eslint-disable max-len */
|
|
|
|
|
export function get_readme (
|
|
|
|
|
software: string,
|
|
|
|
|
description: string,
|
|
|
|
|
dev: boolean,
|
|
|
|
|
license: string,
|
|
|
|
|
author: string
|
|
|
|
|
): string {
|
|
|
|
|
return `# ${software}
|
|
|
|
|
|
2020-05-13 11:39:46 +02:00
|
|
|
version: 0.0.0
|
|
|
|
|
|
2020-05-11 12:21:18 +02:00
|
|
|
${description}
|
2020-05-11 11:33:34 +02:00
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
npm:
|
|
|
|
|
|
|
|
|
|
> npm i --save${dev ? '-dev' : ''} ${software}
|
|
|
|
|
|
|
|
|
|
yarn:
|
|
|
|
|
|
|
|
|
|
> yarn add ${dev ? '--dev' : ''} ${software}
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
TODO: Add usage
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
${license} © ${author}
|
|
|
|
|
`;
|
|
|
|
|
}
|
