Class: ReadmeCreator

Defined in: src\run.coffee

Overview

Creates a README.md based on information from package.json and other files

Class Method Summary

Instance Method Summary

Class Method Details

~ (void) run(args, cb)
~ (Promise) run(args)

Run the script

Overloads:

~ (void) run(args, cb)

Parameters:

  • args ( Array ) — The arguments to the script.
  • cb ( Function ) — A node-style callback that will be called with any error encountered

~ (Promise) run(args)

Parameters:

  • args ( Array ) — The arguments to the script.

Returns:

  • ( Promise ) — A promise that rejects with any errors encountered

Constructor Details

# (void) constructor(options)

Creates a new ReadmeCreator

Parameters:

  • (options) ( Object ) — An optional set of options. See the individual components for details

Options Hash: (options):

  • silent ( Boolean ) — Do not write anything to stdout
  • debug ( Boolean ) — Write useful debug messages to stdout

Instance Method Details

# (Promise) parse()

Parse the readme data

Returns:

  • ( Promise ) — A promise for the data needed for rendering the template

# (void) render(content)

Render the content to the README file template @returns [Promise] The rendered template

Parameters:

  • content ( Object ) — An object with the data needed for the template

# (Promise) write(content)

Write the given content to the README file

Parameters:

  • content ( String ) — The content to write

Returns:

  • ( Promise ) — A promise that resolves when the writing was successful

    Quickly fuzzy find classes, mixins, methods, file:

    Control the navigation frame:

    You can focus and blur the search input: