Merge pull request #2 from Diaszano/feature/createReadme

Feature/create readme

.gitignore

@@ -250,7 +250,7 @@ out
 
 # Nuxt.js build / generate output
 .nuxt
-dist
+#dist
 
 # Gatsby files
 .cache/

README.md

@@ -0,0 +1,93 @@
+<header>
+<div align="center">
+
+<a href="https://github.com/Diaszano">
+    <img src="docs/assets/logo.svg" alt="logo" height="90" align="center">
+</a>
+
+<h1 align="center">linketrackjs</h1>
+
+<p>Uma interface amigável para a API de rastreamento de encomendas dos Correios desenvolvida pela <a href="https://linketrack.com/">Link & Track.</a></p>
+
+<a href="https://www.npmjs.com/package/linketrackjs">
+    <img alt="npm" src="https://img.shields.io/npm/v/linketrackjs?color=orange">
+</a>
+
+<a href="https://www.npmjs.com/package/linketrackjs">
+    <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/min/linketrackjs?color=orange">
+    <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/linketrackjs?color=orange">
+</a>
+
+<a href="https://github.com/Diaszano/linketrackjs">
+    <img alt="NPM" src="https://img.shields.io/npm/l/linketrackjs?color=orange">
+</a>
+
+<a href="https://github.com/Diaszano/linketrackjs">
+    <img alt="GitHub top language" src="https://img.shields.io/github/languages/top/diaszano/linketrackjs?color=orange">
+</a>
+
+</div>
+</header>
+
+## Introdução
+
+O projeto **linketrackjs** tem como objetivo principal criar uma interface mais amigável e intuitiva para a
+utilização da API disponibilizada pelo [Linketrack](https://linketrack.com/), uma plataforma especializada em
+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.
+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.
+
+## Instalação
+
+Para instalar a biblioteca, utilize o gerenciador de pacotes npm da seguinte maneira:
+
+```shell
+npm i linketrackjs
+```
+
+## Configuração
+
+Para utilizar a plataforma, é necessário criar uma conta vinculada ao serviço [Link & Track](https://linketrack.com/).
+Para proceder com esse registro, é imprescindível enviar um e-mail para [api@linketrack.com](mailto:api@linketrack.com),
+solicitando a autorização de uso.
+
+Por favor, considere que o envio do e-mail é um requisito obrigatório para acessar as funcionalidades disponíveis. Sua
+solicitação será processada pela equipe responsável, que fornecerá as informações necessárias para que você possa
+desfrutar de todas as vantagens oferecidas pelo serviço [Link & Track](https://linketrack.com/).
+
+## Utilização
+
+Para utilizar o cache em sua aplicação, é necessário importar a classe **linketrack** da biblioteca:
+
+```typescript
+import Linketrack from 'linketrackjs';
+```
+
+Em seguida, é possível criar uma instância da classe **linketrack** e utilizá-la:
+
+```typescript
+const linketrack = new Linketrack('user', 'token');
+
+// Rastreie uma encomenda
+const track = await linketrack.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);
+```

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/assets/highlight.css

@@ -0,0 +1,108 @@
+:root {
+    --light-hl-0: #795E26;
+    --dark-hl-0: #DCDCAA;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #A31515;
+    --dark-hl-2: #CE9178;
+    --light-hl-3: #AF00DB;
+    --dark-hl-3: #C586C0;
+    --light-hl-4: #001080;
+    --dark-hl-4: #9CDCFE;
+    --light-hl-5: #0000FF;
+    --dark-hl-5: #569CD6;
+    --light-hl-6: #0070C1;
+    --dark-hl-6: #4FC1FF;
+    --light-hl-7: #008000;
+    --dark-hl-7: #6A9955;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) {
+    :root {
+        --hl-0: var(--light-hl-0);
+        --hl-1: var(--light-hl-1);
+        --hl-2: var(--light-hl-2);
+        --hl-3: var(--light-hl-3);
+        --hl-4: var(--light-hl-4);
+        --hl-5: var(--light-hl-5);
+        --hl-6: var(--light-hl-6);
+        --hl-7: var(--light-hl-7);
+        --code-background: var(--light-code-background);
+    }
+}
+
+@media (prefers-color-scheme: dark) {
+    :root {
+        --hl-0: var(--dark-hl-0);
+        --hl-1: var(--dark-hl-1);
+        --hl-2: var(--dark-hl-2);
+        --hl-3: var(--dark-hl-3);
+        --hl-4: var(--dark-hl-4);
+        --hl-5: var(--dark-hl-5);
+        --hl-6: var(--dark-hl-6);
+        --hl-7: var(--dark-hl-7);
+        --code-background: var(--dark-code-background);
+    }
+}
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 {
+    color: var(--hl-0);
+}
+
+.hl-1 {
+    color: var(--hl-1);
+}
+
+.hl-2 {
+    color: var(--hl-2);
+}
+
+.hl-3 {
+    color: var(--hl-3);
+}
+
+.hl-4 {
+    color: var(--hl-4);
+}
+
+.hl-5 {
+    color: var(--hl-5);
+}
+
+.hl-6 {
+    color: var(--hl-6);
+}
+
+.hl-7 {
+    color: var(--hl-7);
+}
+
+pre, code {
+    background: var(--code-background);
+}