diff --git a/README.md b/README.md index 4f204c9..5767d9a 100644 --- 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 -``` \ No newline at end of file +``` diff --git a/docs/img/gui_v01.png b/docs/img/gui_v01.png new file mode 100644 index 0000000..8bb4ae4 Binary files /dev/null and b/docs/img/gui_v01.png differ diff --git a/docs/docs/index.md b/docs/index.md similarity index 100% rename from docs/docs/index.md rename to docs/index.md diff --git a/docs/mkdocs.yml b/mkdocs.yml similarity index 100% rename from docs/mkdocs.yml rename to mkdocs.yml