xtnsn/scripts/readme.js

The CLI for your next Chrome Extension.

'use strict';

const path = require('path');
const fs = require('fs-extra');

const { prettifyAppName } = require('../utils/name');

function generateReadme(appDetails, appPath) {
  const appName = prettifyAppName(appDetails.name);

  const readme = `# <img src="public/icons/icon_48.png" width="45" align="left"> ${appName}

${appDetails.description}

## Features

- Feature 1
- Feature 2

## Install

[**Chrome** extension]() <!-- TODO: Add chrome extension link inside parenthesis -->

## Contribution

Suggestions and pull requests are welcomed!.

---

`;

  fs.writeFileSync(path.join(appPath, 'README.md'), readme);

  return true;
}

module.exports = generateReadme;