Skip to content

Commit

Permalink
update: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
caioagiani committed Feb 12, 2021
1 parent eb6ab1f commit 8c610e7
Showing 1 changed file with 47 additions and 10 deletions.
57 changes: 47 additions & 10 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,64 @@
*/
-->

<div style="align-items: center; text-align: center;">
<p align="center">
<a href="https://mobizon.com.br">
<img src=".github/logo.svg" alt="MobizonBR" title="MobizonBR">
<img src=".github/default.svg" width="60%" alt="MobizonBR" title="MobizonBR">
</a>
</p>

<h2>Biblioteca para comunicação API HTTP Mobizon SMS</h2>
<h2 align="center">Biblioteca para comunicação API HTTP Mobizon SMS</h2>

<p align="center">
<img alt="GitHub language count" src="https://img.shields.io/github/languages/count/caioagiani/mobizon-br">
<img alt="GitHub top language" src="https://img.shields.io/github/languages/top/caioagiani/mobizon-br">
<img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/caioagiani/mobizon-br">
<img alt="GitHub last commit" src="https://img.shields.io/badge/license-MIT-blue.svg">
</div>
<img alt="GitHub license" src="https://img.shields.io/badge/license-MIT-blue.svg">
</p>

## Installation
## Instalação

Download node at [nodejs.org](http://nodejs.org) and install it, if you haven't already.
Baixe o node em [nodejs.org](http://nodejs.org) e instale-o, caso ainda não tenha,

```sh
npm install mobizon-br or yarn install mobizon-br
Pacote: `npm i mobizon-br` ou `yarn install mobizon-br`

## Configuração:

```js
const mobizon = require('mobizon-br');

/**
* Obtenha sua chave em: https://mobizon.com.br
*/
mobizon.setKey(process.env.API_KEY);
```
## Test

Veja todos os [exemplos](https://github.com/mobizon/mobizon-php/tree/master/docs/examples).
```js

(async () => {
/**
* Saldo
*/
const getBalance = await mobizon.getBalance();

console.log(getBalance);

/**
* Encurtar url
*/
const short = await mobizon.short({
fullLink: 'https://mobizon.com.br',
status: 1,
expirationDate: '',
comment: 'MobizonBR',
});

console.log(short);
})();
```

## Testes

```javascript
$ jest --setupFiles dotenv/config --detectOpenHandles --forceExit
Expand Down

0 comments on commit 8c610e7

Please sign in to comment.