https://github.com/aichholzer/unsullied

Call me unsullied.
https://github.com/aichholzer/unsullied

Last synced: 25 days ago
JSON representation

Call me unsullied.

• Host: GitHub
• URL: https://github.com/aichholzer/unsullied
• Owner: aichholzer
• License: mit
• Created: 2017-05-15T22:52:59.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-05-23T12:17:52.000Z (over 4 years ago)
• Last Synced: 2024-04-23T13:17:39.103Z (7 months ago)
• Language: JavaScript
• Size: 15.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# UNSULLIED

[![Greenkeeper badge](https://badges.greenkeeper.io/aichholzer/Unsullied.svg)](https://greenkeeper.io/)

[![Build Status](https://travis-ci.org/aichholzer/Unsullied.svg?branch=master)](https://travis-ci.org/aichholzer/Unsullied)

[![Downloads](https://img.shields.io/npm/dt/unsullied.svg)](https://www.npmjs.com/package/unsullied)

[![Always useful](https://img.shields.io/badge/always-useful-ff6400.svg)](https://github.com/aichholzer/Unsullied)

Random `unsullied` name generator.

### Install

```

npm install --save unsullied

```

If you need to use it as a CLI tool:

```

npm install -g unsullied

```

### Use

```

const unsullied = require('unsullied');

const name = unsullied();

// 'grey.worm'

```

With options:

```

const unsullied = require('unsullied');

const name = unsullied({

  separator: '-'

});

// 'grey-worm'

```

### Available options

* case: `upper` || `camel`,

* separator: `[string]` (Default: .),

### CLI use:

```

$> unsullied

// 'grey.worm'

```

```

$> unsullied --case=upper

// GREY.WORM

```

```

$> unsullied --case=camel

// grey.Worm

```

### Contribute

```

fork https://github.com/aichholzer/unsullied/

```

More ideas for **adjectives** and **vermin** (See `./lib/data.json`) are always welcome.

### License

[MIT](https://github.com/aichholzer/unsullied/blob/master/LICENSE)