0.0.1 • Published 7 years ago

burlesk v0.0.1

Weekly downloads
5
License
AGPL-3.0
Repository
github
Last release
7 years ago

burlesk

Build Status Coverage Status Dependency Status

Dereference URLs.

Install

$ npm install --save burlesk

Now with update-notifier

The cli now uses update-notifier to let the user know about updates to this program.

Users have the ability to opt-out of the update notifier by changing the optOut property to true in ~/.config/configstore/update-notifier-rollodeqc-gh-user-streak.json. The path is available in notifier.config.path.

Users can also opt-out by setting the environment variable NO_UPDATE_NOTIFIER with any value or by using the --no-update-notifier flag on a per run basis.

Usage

const burlesk = require('burlesk')

burlesk('unicorns')
//=> 'unicorns & rainbows'

API

burlesk(input, options)

input

Type: string

Lorem ipsum.

options

foo

Type: boolean Default: false

Lorem ipsum.

CLI

$ npm install --global burlesk
$ burlesk --help

  Usage
    burlesk [input]

  Options
    --foo  Lorem ipsum. [Default: false]

  Examples
    $ burlesk
    unicorns & rainbows
    $ burlesk ponies
    ponies & rainbows

License

AGPL-v3 © 2017 Robin Millette

0.0.1

7 years ago