From 45151e3e406d13a7a4f0fb6d32abc0e2d1501f40 Mon Sep 17 00:00:00 2001
From: Erich Keil <39918654+zenlex@users.noreply.github.com>
Date: Sat, 16 Nov 2024 11:40:28 -0600
Subject: [PATCH] Update README.md

---
 README.md | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 77812aa..6ffe2f7 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,26 @@
-# Tauri + Leptos
+# tomaru
 
-This template should help get you started developing with Tauri and Leptos.
+<i>The pomodoro timer project I've wanted but not found, so I'm building one for myself</i>
 
-## Recommended IDE Setup
+## Technologies
+- Rust 🦀
+- Tauri for cross platform build & deployment
+- Leptos for UI
+  
+## Development Roadmap
+### MVP - CLI
+- CLI tool 
+- Simple, easy to configure settings via command line flags and a default config file:
+  - work period length
+  - short break
+  - long break
+  - number of cycles before long break
+- Visible and audible notifications on all platforms (using system notifications where possible)
+- Mac / Windows / Linux (WSL) support
 
-[VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer).
+### Phase 2 - Native
+- Compile to web and native mobile and desktop platforms with simple UI
+- Add synchronization for web (allow multiple users to share a timer via URL)
+
+### Phase 3 - Embedded
+- Build an esp32 based standalone timer device with LEDs, e-ink screen and small speaker that runs same/derived code for core logic