readme-manager ​

ReadmeManager ​

The ReadmeManager class provides functionalities to manage the README file of the project. It offers methods to create or update the README based on the provided arguments and configurations.

Kind: global class

readmeManager.create(options, deletedPaths) ⇒ Promise.<void> ​

Creates or updates the README file based on the provided arguments.

Kind: instance method of ReadmeManager
Returns: Promise.<void> - A promise that resolves once the README is created or updated.

Example

const readmeManager = new ReadmeManager();
await readmeManager.create(cliArgs, deletedPathsArray);

const readmeManager = new ReadmeManager();
await readmeManager.create(cliArgs, deletedPathsArray);