0.1.1 • Published 8 years ago

mmws v0.1.1

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

mmws

Build Status Coverage Status Dependency Status

Mattermost websocket client.

Install

$ npm install --save mmws

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 mmws = require('mmws')

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

API

mmws(input, options)

input

Type: string

Lorem ipsum.

options

foo

Type: boolean Default: false

Lorem ipsum.

CLI

$ npm install --global mmws
$ mmws --help

  Usage
    mmws [input]

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

  Examples
    $ mmws
    unicorns & rainbows
    $ mmws ponies
    ponies & rainbows

License

AGPL-v3 © Robin Millette