Skip to content

Commit

Permalink
docs(readme): update readme with the information about the new features
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexandre Batistella Bellas committed Nov 2, 2021
1 parent 7534681 commit 671e717
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,19 @@ npm i bling-erp-api
### Javascript

```js
const Bling = require('bling-erp-api')
const { Bling } = require('bling-erp-api')
```

### Typescript

```ts
import Bling from 'bling-erp-api'
import { Bling } from 'bling-erp-api'
```

## Criação de uma nova conexão

Para criar uma conexão ao serviço do Bling, basta instanciar o objeto com a [API
key](https://ajuda.bling.com.br/hc/pt-br/articles/360046937853-Introdu%C3%A7%C3%A3o-para-a-API-do-Bling-para-desenvolvedores-) em seu construtor.
key](https://ajuda.bling.com.br/hc/pt-br/articles/360046937853-Introdu%C3%A7%C3%A3o-para-a-API-do-Bling-para-desenvolvedores-) em seu construtor. Lembre-se de sempre guardar a sua API key em seu arquivo `.env`.

```js
const apiKey = 'sua_api_key'
Expand All @@ -43,12 +43,19 @@ const blingConnection = new Bling(apiKey)

## Entidades disponíveis

As entidades atualmente permitidas para interação são somente:
As entidades atualmente permitidas para interação são:

- Produtos
- Pedidos
- Contatos (`.contacts()`)
- Depósitos (`.deposits()`)
- Pedidos (`.orders()`)
- Pedidos de compra (`.purchaseOrders()`)
- Produtos (`.products()`)
- Propostas comerciais (`.commercialProposals()`)

Em breve serão adicionadas mais.
Adicionaremos as restantes de acordo com as _releases_. Por ora, estamos focando
no funcionamento do pacote e no teste correto das entidades.
Além disso, as entidades no código estão em inglês. Em breve também deixaremos
disponíveis os métodos em português.

## Métodos permitidos

Expand Down Expand Up @@ -85,4 +92,4 @@ tecnologias e estrutura do projeto são:
- Alexandre Batistella Bellas; [LinkedIn](https://linkedin.com/in/alebatistella/)
- Vitor Santana Cordeiro; [LinkedIn](https://linkedin.com/in/vitorsanc)

No futuro, contribuições da comunidade serão extremamente apreciadas! Ainda não possuímos as *guidelines de contribuição* definidas (`CONTRIBUTING.md`), mas assim que as tivermos nós iremos apreciar fortemente a contribuição da comunidade, inclusive por meio da abertura de *issues* 😊
No futuro, contribuições da comunidade serão extremamente apreciadas! Ainda não possuímos as _guidelines de contribuição_ definidas (`CONTRIBUTING.md`), mas assim que as tivermos nós iremos apreciar fortemente a contribuição da comunidade, inclusive por meio da abertura de _issues_ 😊

0 comments on commit 671e717

Please sign in to comment.