https://github.com/weichiachang/regular-show

🎮 Get random name of Regular Show
https://github.com/weichiachang/regular-show

regular-show regular-show-cli

Last synced: 11 months ago
JSON representation

🎮 Get random name of Regular Show

• Host: GitHub
• URL: https://github.com/weichiachang/regular-show
• Owner: WeiChiaChang
• License: mit
• Created: 2017-10-08T07:38:33.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-10-08T11:43:41.000Z (over 8 years ago)
• Last Synced: 2024-10-30T00:47:15.806Z (over 1 year ago)
• Topics: regular-show, regular-show-cli
• Language: JavaScript
• Homepage:
• Size: 23.4 KB
• Stars: 5
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## regular-show [![Build Status](https://travis-ci.org/WeiChiaChang/regular-show.svg?branch=master)](https://travis-ci.org/WeiChiaChang/regular-show)

> Get random name of Regular Show

![regular-show](https://i.imgur.com/WBuT5e3.jpg)

Photo credit : [3 Very Important Life Lessons From Regular Show](https://www.theodysseyonline.com/3-very-important-life-lessons-from-regular-show)

This name lists are just JSON files and you can use wherever.

Being a super fans of Regular Show, I have to do something to commemorate my favorite cartoon.

This project highly learned from [sindresorhus/superb](https://github.com/sindresorhus/superb).

## Installation

```shell

$ npm i --save regular-show

```

## Usage

```shell

var regularShow = require('regular-show');  // Conventional but classic way

import regularShow from 'regular-show';     // Or much more modern ES6  way

regularShow();

// Mordecai

regularShow();

// Rigby

regularShow.words;

// ['Mordecai', 'Rigby', ...]

```

## API

regularShow()

Type: `string`

Generate random character's name of Regular Show.

regularShow.names

Type: `array`

Fetch all of the names.

## CLI

```shell

$ npm i regular-show -g

```

```shell

$ npm regular-show --help

  

  Get random name of Regular Show

  Examples

    $ regular-show

    Mordecai

    $ regular-show --all

    Rigby

    Eileen

    Muscle Man

    ...

  Options

    --all  Fetch all the names rather than a random name

```

## License

MIT © [WeiChiaChang](https://github.com/WeiChiaChang)