Skip to content

Commit ae620cf

Browse files
committed
Added changes to Readme
1 parent 57974db commit ae620cf

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# pensador-api
2+
23
🤔 Pensador é um pacote Node que traz frases de pensadores
34

45
## Instalação
56

67
```
7-
yarn add pensador-api
8+
yarn add pensador-api
89
// or
910
npm install --save pensador-api
1011
```
@@ -13,9 +14,7 @@ npm install --save pensador-api
1314

1415
Primeiro, importe o pacote e depois chame a função passando as opções.
1516

16-
17-
*NOTE*: pensador-api é assíncrono, logo você deve usar Promises ou Async/Await.
18-
17+
_NOTE_: pensador-api é assíncrono, logo você deve usar Promises ou Async/Await.
1918

2019
```
2120
const pensador = require('pensador-api')
@@ -55,13 +54,14 @@ const array = await pensador({ term: "Elon Musk", max: 5 })
5554
*/
5655
```
5756

58-
5957
## Opções
6058

61-
*term* (obrigatória) (string)
59+
_term_ (opcional) (string)
6260

6361
Um termo a ser pesquisado. O pacote irá adicionar automaticamente o prefixo "frases de", padrão do site Pensador.com
6462

65-
*max* (opcional) (integer)
63+
Caso nenhum seja utilizado, o term padrao será "frases_curtas"
64+
65+
_max_ (opcional) (integer)
6666

67-
Número máximo de registros que o pacote deve retornar. Deixe me branco para capturar todos os disponíveis no termo.
67+
Número máximo de registros que o pacote deve retornar. Deixe me branco para capturar todos os disponíveis no termo.

0 commit comments

Comments
 (0)