https://github.com/umayr/burrp

A tiny CLI app to generate food names.
https://github.com/umayr/burrp

Last synced: about 15 hours ago
JSON representation

A tiny CLI app to generate food names.

• Host: GitHub
• URL: https://github.com/umayr/burrp
• Owner: umayr
• Created: 2015-07-11T17:32:26.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-08-13T09:01:20.000Z (about 9 years ago)
• Last Synced: 2024-10-07T13:48:50.949Z (about 1 month ago)
• Language: JavaScript
• Size: 195 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
Burrp

=============

### Description

A CLI app to generate food names.

### Usage

##### Command Line:

To install burrp globally from npm, run:

```

$ npm install -g burrp

```

Once its installed, it can be used via command line. Try:

```

$ burp -V

0.1.0

$ burp -h

  Usage: burrp [options]

  Options:

    -h, --help        output usage information

    -V, --version     output the version number

    -n, --number   Number of food names

$ burp

White Wine and Walnut Tart

$ burp

Strawberry and Coconut Pie

Dark Chocolate and Ginger Mooncake

Strawberry and Kiwi Cake

Coffee and Caramel Pastry

Pressure-Cooked White Wine Kebabs

Pressure-Fried Fennel & Lemon Pie

Infused White Wine Potatoes

Cinnamon and Grape Genoise

Passion Fruit Toast

Tea-Smoked Mint Roll

```

Note: This package registers two commands, `burrp` & `burp`. You can use either of those for cli.

#### Programmatically

To install burrp as a dependency:

```

$ npm install --save burrp

```

Then use it as:

``` javascript

var burp = require('burrp').burp;

burp();

// [ "Fire-Grilled Honey & Thyme Boar" ]

```

### Tests

If you have [mocha](https://github.com/mochajs/mocha) installed already,

```

$ npm test

```

### Motivation

I used to name my releases after dishes names, like every single lazy ass developer; I wanted a utility that'd reduce my efforts. So, here it is. :3

### License

Copyright (c) 2015 Umayr Shahid

[MIT License](http://en.wikipedia.org/wiki/MIT_License)