```sh-session
$ readme-md --help

  Automatically generate a readme for your project from the CLI.

  Usage
      $ readme-md [init]

  Options
      --help, -h               Display this message.
      --non-interactive, -n    Run in non-interactive mode.
      --version, -v            Display the application version.

  When invoked with the "init" sub-command a project level runtime
  configuration is initialized.
```

For more detailed information see the [doc directory](doc/) or view the [project's config directory](.config/readme-md/) for example usage.
For example output this `README.md` is entirely self generated by this package.