Update README.md

README.md

@@ -1,5 +1,9 @@
 # JWT Authentication API
 
+Aluno: Pedro Henrique Stanzani de Freitas
+
+Arquivo `compose.yaml`: [link](https://raw.githubusercontent.com/pedrostanzani/jwt-auth-api/refs/heads/main/compose.yaml)
+
 Esse projeto foi desenvolvido para a disciplina de Computação em Nuvem e demonstra uma API de autenticação com JWTs (JSON Web Tokens) que foi desenvolvida com ElysiaJS, Bun e TypeScript.
 
 ## Estrutura
@@ -13,6 +17,10 @@ Esse projeto foi desenvolvido para a disciplina de Computação em Nuvem e demon
 
 A documentação está disponível em [jwt-auth-cloud.vercel.app](https://jwt-auth-cloud.vercel.app/).
 
+## Docker Hub
+
+A imagem do servidor ElysiaJS foi publicada no Docker Hub e está disponível [neste link](https://hub.docker.com/repository/docker/pedrostanzani/jwt-auth-api/general).
+
 ## Tecnologias utilizadas
 
 Foram utilizadas as seguintes tecnologias:
@@ -26,3 +34,35 @@ E as seguintes bibliotecas foram utilizadas para desenvolver o serviço de web s
 
 - Cheerio: biblioteca para parsing de HTML
 - Axios: cliente HTTP para fazer requisições web
+
+## Explicação do scraping
+
+O endpoint de consulta retorna uma lista de manchetes da BBC. Essas manchetes são armazenadas em cache (memória) e atualizam de hora em hora.
+
+Para realizar o scraping, uma requisição HTTP é realizada ao site da BBC. O payload dessa requisição passa por um parsing com funções da biblioteca Cheerio. Consulte o código do [serviço de Scraping](./app/src/services.ts) para saber mais.
+
+
+## Execução da aplicação
+
+Siga as seguintes instruções para instalar e executar o projeto.
+
+1. Faça o download do arquivo [compose.yaml](https://raw.githubusercontent.com/pedrostanzani/jwt-auth-api/refs/heads/main/compose.yaml) e armazene-o em um diretório vazio.
+
+2. Execute o comando abaixo no terminal do diretório em que o arquivo compose.yaml foi armazenado:
+  ```bash
+  docker compose up
+  ```
+
+3. Agora você pode acessar a API em [http://localhost:3000](http://localhost:3000).
+
+
+## Screenshots dos endpoints testados
+
+- Cadastro de usuários
+  ![Captura de tela do teste do endpoint de cadastro de usuários](./assets/sign-up.png)
+
+- Login de usuários
+  ![Captura de tela do teste do endpoint de login de usuários](./assets/sign-in.png)
+
+- Consulta de dados
+  ![Captura de tela do teste do endpoint de consulta de dados](./assets/data.png)