Merge pull request #1 from PythonFloripa/feat/documentacao

rafaelcalixto · web-flow · commit 5cd32241c2c1 · 2024-05-14T11:54:31.000-03:00
feat: Adiciona documentação de uso
diff --git a/.gitignore b/.gitignore
@@ -158,3 +158,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# PyNewsScraper
+pynews.json
diff --git a/README.md b/README.md
@@ -1,2 +1,27 @@
 # PyNewsScraper
-Este projeto é um scraper para verificar as bibliotecas Python que tiveram atualização no último mês e listá-las, facilitando a identificação de bibliotecas com major version releases.
+
+Este projeto é um scraper (raspador de dados) para verificar as bibliotecas Python que tiveram atualização no último mês e listá-las, facilitando a identificação de bibliotecas com lançamentos de versão major.
+
+# Como utilizar
+
+Para criar um ambiente virtual, execute
+```
+python -m venv .venv
+```
+
+Para ativar o ambiente virtual, execute
+```
+source .venv/bin/activate
+```
+
+Para instalar as dependências do projeto no ambiente virtual, execute
+```
+pip install -r requirements.txt
+```
+
+Para rodar o scrapper, execute
+```
+python getNews.py
+```
+
+Para desativar o ambiente virtual, execute `deactivate`.
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,3 @@
+requests==2.31.0
+beautifulsoup4==4.12.3
+babel==2.15.0
