mice.js/README.md

A javascript library to work with club-mice.com API

# mice.js
É um wrapper em javascript para trabalhar com a API do [Club Mice](https://club-mice.com).

## Links
* :mouse: [Club Mice](https://club-mice.com)
* :us: [Documentation in English](docs/en/README.md)
* :es: [Documentación en Español](docs/es/README.md)
## Informações

>:exclamation: Club Mice API é uma ferramenta projetada para desenvolvedores que permite obter dados dos perfis do Transformice. Graças a esta ferramenta, você pode mostrar informações sobre ratos em sua aplicação.

> :exclamation: Primeiro de tudo, é importante saber que a API nem sempre funciona. O Transformice leva cerca de 1 hora para atualizar os perfis e, durante esse período, a API do Mice do Clube não funcionará, exceto a classificação.

## Instalação
> Utilizando o NPM
```bash
$ npm install mice.js --save
```
> Utilizando o Yarn
```bash
$ yarn add mice.js
```
## Como usar
```js
const mice = require('mice.js')

mice.mouse.getData('Ramonrod').then(data => {
  // aqui você manipula os dados.
}
```
## Métodos
> Aqui estão alguns métodos que a biblioteca oferece.
### mouse.getData(nome)
> Retorna os dados do Jogador

**Argumentos**
| Argumento | Tipo | Opções |
|-----------|-------|-------|
|`nome`   |*String* | 'Procura os dados do Jogador'|

**Exemplo**
```js
mice.mouse.getData('Ramonrod').then(data => {
  console.log(`Você jogou ${data.round_played} partidas.`)
}
```
### tribe.getByName(nome || id)
> Retorna os dados da Tribol

**Argumentos**
| Argumento | Tipo | Opções |
|-----------|-------|-------|
|`nome`   |*String* | 'Procura pelo o nome da Tribo'|

**Exemplo**
```js
// Procurando com nome
mice.tribe.getByName('Vamos CNB').then(tribe => {
  console.log(`O ID da tribo é ${tribe.id}`)
}
```

## Autor
[Ramon Rodrigues](https://github.com/ramonpds)

## Licença
Este projeto esta sob a licença do MIT, leia o arquivo [`LICENCE.md`](LICENSE.md) para mais informações.