Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
typerat committed Jan 13, 2021
1 parent 6fdec41 commit a745e25
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,24 @@ of a program (as in the Ubuntu naming scheme).

## Usage

#### func Get
#### func Get

```go
func Get(input []byte) string
func Get(input interface{}) string
```
Get returns pseudorandom words for a given input.

Get returns pseudorandom words for a given byte slice.

#### func Random
#### func Random

```go
func Random() string
```

Random returns almost true random words.

#### func RandomAdjective
#### func RandomAdjective

```go
func RandomAdjective() string
```

RandomAdjective returns a random adjective. Use the adjective to describe any
noun devoid of a description.

0 comments on commit a745e25

Please sign in to comment.