Nicer readme, and refurbished the documentation

2024-05-25 16:25:22 +02:00 · 2024-05-25 16:25:22 +02:00 · 48a746b313
parent 8282f8e0dd
commit 48a746b313
4 changed files with 13 additions and 2 deletions
--- a/README.md
+++ b/README.md
@ -1,11 +1,22 @@
 # hellocomputer

-Analytics with natural language
+[Hello, computer!](https://youtu.be/hShY6xZWVGE?si=pzJjmc492uLV63z-)
+
+`hellocomputer` is a GenAI-powered web application that allows you to analyze spreadsheets 
+
+![gui](./docs/img/gui_v01.png)
+
+
+## Quick install and run
+
+If you have `uv` installed, just clone the repository and run:

 ```
 uv pip install -r requirements.in
 ```

+And to get the application up and running...
+
 ```
 uvicorn hellocomputer.main:app --host localhost
 ```
--- a/docs/img/gui_v01.png
+++ b/docs/img/gui_v01.png
--- a/docs/docs/index.md
+++ b/docs/docs/index.md
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml