From 3595824b99db3b68155cfa8177d54bf317b60adc Mon Sep 17 00:00:00 2001
From: bartek <bartzagr@gmail.com>
Date: Tue, 23 Jul 2024 20:00:29 +0200
Subject: [PATCH] docs: readme

---
 README.md | 44 +++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 43 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 4184f89..8148616 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,43 @@
-🧸
+<h1 align="center">
+<img src="https://zagrodzki.me/_next/image?url=%2Fimg%2Fprojects%2Fteddy%2Fthumbnail.png&w=3840&q=75" alt="app logo" width="100%"/>
+
+</h1>
+
+<h4 align="center">Teddy - personalizable AI assistant</h4>
+
+## Project Overview 🎨
+
+Custom desktop AI app wrapper built on top of OpenAI GPT API especially for enhancing daily workflow and saving time doing repeatable stuff.
+When you find something not working open an [issue](https://github.com/Bartek532/teddy/issues) or directly make a [pull request](https://github.com/Bartek532/teddy/pulls). Enjoy!
+
+## Read more
+
+[Read full case study →](https://zagrodzki.me/work/teddy)
+
+## Tech/framework used 🧰
+
+| Tech                                                                 | Description                               |
+| -------------------------------------------------------------------- | ----------------------------------------- |
+| [Typescript](https://www.typescriptlang.org/)                        | Javascript superset language              |
+| [Tauri](https://tauri.app/)                                          | Desktop framework for multi-platform apps |
+| [React](https://reactjs.org/)                                        | Library for building user interfaces      |
+| [GPT](https://openai.com/api/)                                       | Most advanced large language model        |
+| [Tauri Rust Store](https://github.com/tauri-apps/tauri-plugin-store) | Tauri plugin for storing data locally     |
+| [Github Actions](https://github.com/features/actions)                | Automations for workflow improvements     |
+| [SCSS](https://sass-lang.com)                                        | CSS with superpowers                      |
+| [React Hook Form](https://react-hook-form.com)                       | Forms with easy-to-use validation         |
+| [Husky](https://github.comtypicode/husky)                            | Git hooks                                 |
+| [ESLint](https://eslint.org/)                                        | TypeScript linting                        |
+| [Prettier](https://prettier.io/)                                     | Code formatter                            |
+
+## Installation 💿
+
+```bash
+
+git clone https://github.com/Bartek532/teddy.git
+
+pnpm install
+
+pnpm run tauri dev
+
+```