From bcbfd481864315a34048287190a0f47683b45830 Mon Sep 17 00:00:00 2001
From: Matthew Kosarek <matthew@matthewkosarek.xyz>
Date: Tue, 19 Dec 2023 10:39:11 -0500
Subject: [PATCH] readme: needs refining, but its ok

---
 README.md | 60 +++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 41 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 6617f62..d529a82 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,14 @@
-# Miracle - a Tiling WM based on Mir
-**Miracle** is a pleasant tiling window manager based on *Mir*. The emphasis is on usability for normal people,
-rather than maximum extensibility for hackers. My goal is for everyone to enjoy the beauty of tiling window managers
-without needing to be a nerd.
+# miracle
+**miracle** is a _Mir_-based wayland desktop environment inspired by modern IDEs like CLion. The window manager intends
+to provide a typical tiling window management experience (akin to i3 or sway). The shell itself focuses on extendability
+for power users while at the same time having an accessible user interface. While window managers like i3 and sway
+are simple and easy-to-use, I find that there's a niche missing for programmers who want an out-of-the-box solution
+to an ergonomic but heavy-hitter desktop environment.
 
-## Building
+**WARNING**: This project is very much a work in progress. I have provided a rough roadmap in the timeline section.
+Use at your own risk.
+
+# Building
 ```
 git clone https://github.com/mattkae/miracle.git
 cd miracle
@@ -14,30 +19,47 @@ cmake ..
 ./bin/compositor
 ```
 
-## TODOs V1
-**ETA**: January 1st
+# Timeline
+## Tiling Window Manager (Due: January 1st)
+Version: 0.1
+
+Features:
 - [x] Layout new window
 - [x] Delete window
-- [ ] Resizing windows
-- [ ] Changing selected window with keyboard
-- [ ] Moving window with keyboard
+- [x] Resizing windows
+- [x] Changing selected window with keyboard
+- [x] Moving window with keyboard
 - [ ] Gaps in windows
 - [ ] Account for minimum sizes on windows (e.g. gedit)
 - [ ] Disabling many of the Floating Window Manager features
+- [ ] Handle exclusion zones
+- [ ] Handle output creation, updating, and deletion
+- [ ] 
 
-## TODOs V2
-**ETA**: February 1st
+## Tiling Advanced + Initial Shell (Due: February 1st)
+Version: 0.2
+
+Features:
 - [ ] Workspaces
   - [ ] Moving windows between workspaces
-- [ ] Multi-output support
-  - [ ] Connecting new monitors
-  - [ ] Disconnecting monitors
-  - [ ] Moving windows between monitors
+- [ ] Launcher (Rust + GTK most likely)
+  - [ ] Favorite applications
+  - [ ] Opened applications
+  - [ ] Favorite folders
+  - [ ] Pinned scripts
+- [ ] Top Panel
+  - [ ] Clock
+  - [ ] Battery indicator
+  - [ ] Wifi Indicator
+  - [ ] Lock Screen
 
-## TODOs V3
-**ETA**: March 1st
+## Tiling More Advanced + 
+Version: 0.3
+
+Features:
+- [ ] UI Cleanup
 - [ ] Configuration file
-- [ ] Settings application (built in flutter ideally)
+- [ ] Settings application
 - [ ] Visual Sugar
   - [ ] A workspace visualizer in the top panel (in-memory app)
   - [ ] A tile visualizer in the top panel (in-memory app)
\ No newline at end of file