Updated README

wizelineacademy · Jun 15, 2024 · ecbe1b6 · ecbe1b6
1 parent 8d23172
commit ecbe1b6
Show file tree

Hide file tree

Showing 11 changed files with 49 additions and 103 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,49 @@
-# itesm-socioformador-feb-jun-2024-Croods
+# [KnowX](https://dnutds2j3jjcr.cloudfront.net/)
+
+KnowX es una aplicación web que permite a los usuarios buscar información para comparar sobre un tema específico. La aplicación utiliza varios métodos de web scraping y AI para buscar y analizar información relevante. El usuario puede ver y comparar los resultados para generar una mejor opinion acerca de los productos y/o servicios.
+
+<video width="370" height="260" controls>
+  <source src="wiki_assets/KnowX.mov" type="video/mp4">
+</video>
+
+## Funcionalidades
+
+- **Búsqueda de información**
+- **Especificación de búsqueda**
+- **Comparación de información**
+- **Historial de búsquedas**
+
+<div class="flex">
+  <img src="wiki_assets/knowx1.png" alt="Arquitectura" width="500"/>
+  <img src="wiki_assets/knowx2.png" alt="Arquitectura" width="501"/>
+  <img src="wiki_assets/knowx3.png" alt="Arquitectura" width="500"/>
+  <img src="wiki_assets/knowx4.png" alt="Arquitectura" width="500"/>
+  <img src="wiki_assets/knowx5.png" alt="Arquitectura" width="500"/>
+  <img src="wiki_assets/knowx6.png" alt="Arquitectura" width="500"/>
+</div>
+
+## Arquitectura
+
+<div class="flex">
+  <img src="wiki_assets/arch1.png" alt="Arquitectura" width="500"/>
+  <img src="wiki_assets/arch2.png" alt="Arquitectura" width="485"/>
+</div>
+
+### Estructura de directorios
+
+- **/api** - Código fuente del servicio de AI
+- **/knowx** - Código fuente del monolito de la aplicación
+
+## WIKI
+
+Para más información sobre la aplicación, visita nuestra [Wiki](https://github.com/wizelineacademy/itesm-socioformador-feb-jun-2024-Croods/wiki)
+
+## Autores
+
+```
+Roberto José García Ríos - A01284731
+Diego Gutiérrez Treviño	-	A01284841
+Carolina Nicole González Leal	- A01284948
+Sofía Cantú Talamantes - A01571120
+Ozner Axel Leyva Mariscal	- A01742377
+```
diff --git a/knowx/README.md b/knowx/README.md
diff --git a/wiki_assets/KnowX.mov b/wiki_assets/KnowX.mov
diff --git a/wiki_assets/arch1.png b/wiki_assets/arch1.png
diff --git a/wiki_assets/arch2.png b/wiki_assets/arch2.png
diff --git a/wiki_assets/knowx1.png b/wiki_assets/knowx1.png
diff --git a/wiki_assets/knowx2.png b/wiki_assets/knowx2.png
diff --git a/wiki_assets/knowx3.png b/wiki_assets/knowx3.png
diff --git a/wiki_assets/knowx4.png b/wiki_assets/knowx4.png
diff --git a/wiki_assets/knowx5.png b/wiki_assets/knowx5.png
diff --git a/wiki_assets/knowx6.png b/wiki_assets/knowx6.png