An open API service indexing awesome lists of open source software.

https://github.com/itsjonq/champ

🏆 Champ: Captain, slugger, skip, ace... Get one of these names!
https://github.com/itsjonq/champ

champ name random

Last synced: about 2 months ago
JSON representation

🏆 Champ: Captain, slugger, skip, ace... Get one of these names!

Awesome Lists containing this project

README

          

# 🏆 Champ

> Champ, slugger, skip, ace... Get one of these names!

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

## Getting Started

Add this module to your project by running:

```
npm install @itsjonq/champ
```

## Usage

Import the `getName` function from the library to get a random (awesome) name!

```js
import { getName } from '@itsjonq/champ'

getName()
// slugger
```

## API

#### getName([seed])

Returns a random name (`string`), from the list of names.

###### seed

Type: `number`

Retrieves a specific name from the list of names.

## Thanks

Thanks to [@hownowstephen](https://github.com/hownowstephen) for being such a **champ**!