Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hcaz authored Nov 11, 2018
1 parent 2fc1743 commit e7a436f
Showing 1 changed file with 25 additions and 7 deletions.
32 changes: 25 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
A PHP library to create interesting, sometimes entertaining, random names.
Based on [nubs/random-name-generator](https://github.com/nubs/random-name-generator)!

This fork will be maintained with adinitial generators intended for duct.me

[![Latest Stable Version](http://img.shields.io/packagist/v/nubs/random-name-generator.svg?style=flat)](https://packagist.org/packages/nubs/random-name-generator)
[![Total Downloads](http://img.shields.io/packagist/dt/nubs/random-name-generator.svg?style=flat)](https://packagist.org/packages/nubs/random-name-generator)
[![License](http://img.shields.io/packagist/l/nubs/random-name-generator.svg?style=flat)](https://packagist.org/packages/nubs/random-name-generator)
Expand Down Expand Up @@ -37,8 +39,9 @@ using all of the available generators, you can construct them yourself:
```php
$generator = new \ProbablyRational\RandomNameGenerator\All(
[
new \ProbablyRational\RandomNameGenerator\Alliteration(),
new \ProbablyRational\RandomNameGenerator\Vgng()
new \ProbablyRational\RandomNameGenerator\Alliteration(1),
new \ProbablyRational\RandomNameGenerator\Vgng(1),
new \ProbablyRational\RandomNameGenerator\Sketch(1)
]
);
```
Expand All @@ -60,14 +63,12 @@ video game names generated by this library.

#### Usage
```php
$generator = new \ProbablyRational\RandomNameGenerator\Vgng();
$generator = new \ProbablyRational\RandomNameGenerator\Vgng(1);
echo $generator->getName();
```

## Alliterative Names
The alliteration name generator is based off of a list of
[adjectives](http://grammar.yourdictionary.com/parts-of-speech/adjectives/list-of-adjective-words.html)
and a list of [animals](https://animalcorner.co.uk/animals/).
The sketchy name generator is based off of a server called [verylegit](https://github.com/defaultnamehere/verylegit.link).

#### Examples
* *Agreeable Anaconda*
Expand All @@ -77,7 +78,24 @@ and a list of [animals](https://animalcorner.co.uk/animals/).

#### Usage
```php
$generator = new \ProbablyRational\RandomNameGenerator\Alliteration();
$generator = new \ProbablyRational\RandomNameGenerator\Alliteration(1);
echo $generator->getName();
```

## Sketchy Names
The alliteration name generator is based off of a list of
[adjectives](http://grammar.yourdictionary.com/parts-of-speech/adjectives/list-of-adjective-words.html)
and a list of [animals](https://animalcorner.co.uk/animals/).

#### Examples
* *Verification-safe.com2Fcryptolocker.js3Fauthorize=action*
* *Facebook.com2Ftrojan.gp3Fjava0day=x64*
* *Google.com2Fpccleaner.rar3Fpassword=pccleaner*
* *Appleeid-apple.com2Fwebcam.gp3Flogin=ip-camera*

#### Usage
```php
$generator = new \ProbablyRational\RandomNameGenerator\Sketch(1);
echo $generator->getName();
```

Expand Down

0 comments on commit e7a436f

Please sign in to comment.