Beadme - Build Readme 😂

This is a simple CLI tool to create a README.md for your project. Don't take is seriously, I just wanted to try out some Ruby stuff.

Installation

  gem install beadme

Install from source code

Install via Bundler:

  bundle install

Usage

Using ruby:

  ruby bin/beadme

or using the executable:

Make it executable

  chmod +x bin/beadme

Run it

  bin/beadme

Help

Run beadme -h to see the help message:

  beadme - A CLI tool to create a README.md for your project

  Version: 0.0.1

  Commands:
    beadme -h, --help     # Display this help message
    beadme -v, --version  # Show version

  Options:
    -o, [--output=OUTPUT]  # Output directory
                           # Default: Current directory