Skip to content

Commit

Permalink
Merge pull request #30 from Diaszano/development
Browse files Browse the repository at this point in the history
Development
  • Loading branch information
Diaszano authored Dec 9, 2023
2 parents d62c157 + a132163 commit e1be890
Show file tree
Hide file tree
Showing 31 changed files with 849 additions and 3,168 deletions.
3 changes: 0 additions & 3 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@
"plugin:@typescript-eslint/recommended",
"prettier"
],
"ignorePatterns": [
"*/**.spec.ts"
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": "latest",
Expand Down
File renamed without changes
2 changes: 1 addition & 1 deletion .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ test/
*.test.tsx

# Development and Configuration Files
.github
.github/workflows
.husky
docs
.eslintrc.json
Expand Down
26 changes: 6 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<div align="center">

<a href="https://github.com/Diaszano">
<img src="images/logo.svg" alt="logo" height="90" align="center">
<img src=".github/assets/logo.svg" alt="logo" height="90" align="center">
</a>

<h1 align="center">linketrackjs</h1>
Expand Down Expand Up @@ -38,7 +38,7 @@ rastreamento de encomendas.
A API do [Linketrack](https://linketrack.com/) oferece um conjunto de recursos poderosos para rastrear e obter
informações sobre pacotes e envios, permitindo que desenvolvedores integrem esses recursos em suas aplicações.

O **linketrackjs** busca fornecendo uma camada intermediária entre a API e os usuários finais.
O **linketrackjs** busca fornecer uma camada intermediária entre a API e os usuários finais.
Através dessa camada intermediária, o projeto irá simplificar o processo de integração e fornecer uma experiência mais
amigável para os desenvolvedores que desejam incorporar os recursos de rastreamento em suas aplicações.

Expand All @@ -65,29 +65,15 @@ desfrutar de todas as vantagens oferecidas pelo serviço [Link & Track](https://
Para utilizar o cache em sua aplicação, é necessário importar a classe **linketrack** da biblioteca:

```typescript
import Linketrack from 'linketrackjs';
import { LinkAndTrack } from 'linketrackjs';
```

Em seguida, é possível criar uma instância da classe **linketrack** e utilizá-la:
Em seguida, é possível criar uma instância da classe **linkAndTrack** e utilizá-la:

```typescript
const linketrack = new Linketrack('user', 'token');
const linkAndTrack = new LinkAndTrack('user', 'token');

// Rastreie uma encomenda
const track = await linketrack.track('CODIGO');
const track = await linkAndTrack.track('CODIGO');

// Veja os dados do rastreio
console.log(track);
```

Também será possível rastrear mais de uma encomenda:

```typescript
const linketrack = new Linketrack('user', 'token');

// Rastreie uma encomenda
const track = await linketrack.trackAll('CODIGO1', 'CODIGO2', 'CODIGO3');

// Veja os dados do rastreio
console.log(track);
```
1 change: 0 additions & 1 deletion docs/.nojekyll

This file was deleted.

108 changes: 0 additions & 108 deletions docs/assets/highlight.css

This file was deleted.

58 changes: 0 additions & 58 deletions docs/assets/main.js

This file was deleted.

3 changes: 0 additions & 3 deletions docs/assets/search.js

This file was deleted.

Loading

0 comments on commit e1be890

Please sign in to comment.