update readme with more info

README.md

@@ -1,81 +1,95 @@
-## Readme template da Alura
 
-Template para personalizar readme dos projetos da [Alura](https://www.alura.com.br/). O objetivo deste template é auxiliar as pessoas que pretendem criar readmes mais informativos e descritivos. Considere esse modelo como base, mas se preferir, ajuste os detalhes conforme sua necessidade e caso queira, [confira esse artigo que ensina a personalizar readmes em geral](https://www.alura.com.br/artigos/escrever-bom-readme).
-
-## Exemplos de readmes
+![Thumbnail GitHub](https://user-images.githubusercontent.com/8989346/123303345-171fc980-d4f4-11eb-84ae-cb0e49bfb126.png)
 
-<details>
-  <summary><b>Mobile</b></summary>
-
-- [Android](https://github.com/alura-cursos/android-com-kotlin-personalizando-ui/blob/master/README.md)
-- [React Native](https://github.com/alura-cursos/react-native-comecando-do-zero/blob/main/README.md)
-- [Flutter](https://github.com/alura-cursos/flutter-nuvigator/blob/start/README.md)
-</details>
 
-<details>
-  <summary><b>Front-end</b></summary>
-
-- [JavaScript](https://github.com/vanessametonini/aluramidi-curso/blob/master/README.md) 
-</details>
 
-<details>
-  <summary><b>Programação</b></summary>
-
-- [Kotlin](https://github.com/alura-cursos/kotlin-introducao-orientacao-a-objetos/blob/main/README.md)
-- [Java](https://github.com/gui-lirasilva/Edige-POO/blob/master/README.md)
-
-</details>
+# screenMatch
 
-Ao criar o seu readme, remova todas as informações acima e mantenha apenas a imagem de capa e o conteúdo restante a partir do título **"Nome do projeto"**.
+Este projeto busca filmes, séries e episódios na api da omdb e mostra informações a usuários. Realiza a persistência dessas informações no banco local e disponibiliza um histórico de séries buscadas para o usuários.
 
-## Imagem de capa
+## ⚙️ Configuração do projeto
 
-Adicione a imagem de capa com o tema do seu projeto:
+Para configurar o projeto, siga as etapas abaixo:
 
-![Thumbnail GitHub](https://user-images.githubusercontent.com/8989346/123303345-171fc980-d4f4-11eb-84ae-cb0e49bfb126.png)
+  1. Clone o repositório do projeto:
+
+    git clone https://github.com/matheusfy/screenMatch.git
+
 
-> Você pode pegar a imagem a partir [deste template](https://docs.google.com/presentation/d/1im_-_spDdNEEsfrmjeZet2ZzVKjG-sQSBWfPFJhZ4q0/edit#slide=id.gb6f422ab58_0_111).
+  2. Acesse o diretório do projeto:
 
-> Ou gerar neste [site](https://alurathumbnail.vercel.app/).
+    cd screenMatch
 
-Após adicionar a imagem, também modifique as configurações do projeto para garantir que a imagem vai ser carregada como thumbnail:
 
-**Settings** > **Options** > **Social preview** > **Edit** > **Upload an image...**
+  3. Configuração de variáveis de ambiente:
 
-<details>
-  <summary><b>Demonstração da adição de thumbnail<b/></summary>
-
-![adicionando-imagem-preview](https://user-images.githubusercontent.com/8989346/123303159-e0e24a00-d4f3-11eb-9900-92a8b15bc31b.gif)
-
-</details>
-
-# Nome do projeto
+     - `OPENAI_TOKEN`: gere seu próprio token em [OpenAi Website](https://openai.com/)
+     - `DB_NAME`: Atribua o nome do seu banco de dados ex: 'postgresql'
+     - `DB_USER`: Atribua o nome do seu user do banco ex: 'postgres'
+     - `DB_PASSWORD`: senha utilizado para acessar o banco
+     - `DB_HOST`: O host para acessar o banco ex: 'localhost'
+     - `DB_PORT`: A porta para acessar seu banco de dados: 5432
+     - `OMDB_APIKEY`: obtenha sua key da API da omdb em: [omdbapi](https://omdbapi.com/apikey.aspx)
 
-Descreva o que é o projeto e o que ele faz
 
 ## 🔨 Funcionalidades do projeto
 
-Indique quais são as funcionalidades e comportamentos do App
+<!-- Indique quais são as funcionalidades e comportamentos do App
 
 Se possível, apresente um exemplo visual do projeto, seja gif, imagens ou vídeo, abaixo segue um exemplo:
 
-![](https://github.com/alura-cursos/android-com-kotlin-personalizando-ui/raw/master/img/amostra.gif)
+![](https://github.com/alura-cursos/android-com-kotlin-personalizando-ui/raw/master/img/amostra.gif) -->
+
+
+- `Funcionalidade 1`: Menu com opções de busca de informações das séries:
+  - `1 - Buscar série na web`: retorna ao usuário informações da série caso a série buscada exista
+  - `2 - Buscar episódio`: busca para o usuário todos episódios de totas temporadas
+  - `3 - Lista séries buscadas`: informa a lista de série que já foi pesquisada ao usuário
+  - `4 - Buscar série por título`: Busca uma série no banco de dados dado um titulo informado pelo usuario
+  - `5 - Buscar série por atores`: Busca lista de série no banco de dados dado um nome de ator ou uma parte do nome.
+  - `6 - Buscar série por categoria`: Busca lista de série dada uma categoria informada.
+  - `7 - Buscar as melhor 5 séries avaliadas`: Busca as top 5 séries pela avaliação.
+  - `8 - Busque uma série pela temporada e pela avaliação`: Busca uma série dada informação da temporada e da avaliação.
+  - `9 - Buscar episódio por trecho `: Busca uma lista de episódios que contém um trecho informado pelo usuário.
+  - `10 - Buscar top 5 episodios `: Busca os top 5 episódios de uma série.
+- `Funcionalidade 2`: Menu com opções de busca de informações de filmes.
+  - `Funcionalidade 2a`: descrição da funcionalidade 2a relacionada à funcionalidade 2
 
-## ✔️ Técnicas e tecnologias utilizadas
 
-**Faça uma lista de tecnologias e técnicas utilizadas (a justificativa e descrição são opcionais)**:
 
-- `Funcionalidade 1`: descrição da funcionalidade 1
-- `Funcionalidade 2`: descrição da funcionalidade 2
-  - `Funcionalidade 2a`: descrição da funcionalidade 2a relacionada à funcionalidade 2
-- `Funcionalidade 3`: descrição da funcionalidade 3
+
+  Certifique-se de ter o Node.js instalado em sua máquina antes de executar o projeto.
+
+  Após seguir essas etapas, o projeto estará configurado e em execução.
+
+## ✔️ Técnicas e tecnologias utilizadas
+- `Java`: Versão 17
+- `dependências:`
+  - `Jackson`: Para trabalharmos com manipulação de json.
+  - `Spring Boot`: versão 3.1.11, sem web
+  - `OpenAi`: para conexão com API do chatgpt para tradução das sinopses
+  - `data-jpa`: Para trabalhando com persistência dos dados no banco
+
 
 ## 📁 Acesso ao projeto
 
-**Indique como é possível baixar ou acessar o código fonte do projeto, seja projeto inicial ou final**
+Para acessar o repositório do projeto clique em -> [Repositório](https://github.com/matheusfy/screenMatch)
 
 ## 🛠️ Abrir e rodar o projeto
 
+
+
+### Rodando no Intellij:
+
+
+### Rodando no VsCode:
+
+1. Abra o projeto no intellij.
+2. 
+3. Build a dependencia 
+
+![alt text](image.png)
+
 **Apresente as instruções necessárias para abrir e executar o projeto**
 
 ## 📚 Mais informações do curso