Contents

[![Gem Version](https://badge.fury.io/rb/beadme.svg)](https://badge.fury.io/rb/beadme) [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)

# 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
```sh
  gem install beadme
```

## Install from source code 

Install via Bundler:


```sh
  bundle install
```

## Usage

Using ruby:

```sh
  ruby bin/beadme
```

or using the executable:

### Make it executable

```sh
  chmod +x bin/beadme
```

### Run it

```sh
  bin/beadme
```

## Help

Run `beadme -h` to see the help message:

```sh
  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
```

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
beadme-0.1.5	README.markdown
beadme-0.1.4	README.markdown
beadme-0.1.3	README.markdown
beadme-0.1.2	README.markdown
beadme-0.1.1	README.markdown