-
Notifications
You must be signed in to change notification settings - Fork 18
/
README.template
47 lines (27 loc) · 916 Bytes
/
README.template
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# porreta
[![Build Status](https://travis-ci.org/rafaelrinaldi/porreta.svg?branch=master)](https://travis-ci.org/rafaelrinaldi/porreta)
[![Dependencies Status](https://david-dm.org/rafaelrinaldi/porreta.svg)](https://david-dm.org/rafaelrinaldi/porreta)
> Get funny words in Brazilian Portuguese.
<sup>Inspired by [`superb`](http://github.com/sindresorhus/superb)</sup>
:warning: "porreta" is a word commonly used on the northeast of Brazil to indicate something that is awesome.
Currently `{total_words}` words available.
## Install
```sh
$ npm install porreta --save
```
## Usage
```javascript
var porreta = require('porreta');
porreta(); // pamonha
porreta(); // cangote
porreta.words; // ['alpendre', 'arapuca', 'araraquara', ...]
```
## API
## `porreta()`
Type: `string`
Random funny word.
## `porreta.words`
Type: `array`
All the words.
## License
MIT © [Rafael Rinaldi](http://rinaldi.io)