Starting to go places. More testing in place, need to solidify the dashboard api boundary next

README.md

@@ -0,0 +1,49 @@
+# XP Nix
+
+A productivity tracking and gamification system designed for Linux desktop environments, specifically optimized for Hyprland window manager users.
+
+## Overview
+
+XP Nix transforms your daily computer usage into a gamified experience by monitoring your activity patterns and providing real-time feedback through an XP (experience points) system. The application runs as a background service that intelligently tracks your productivity, detects idle periods, and rewards active engagement with your desktop environment.
+
+## Intended Application
+
+This tool is designed for:
+
+- **Productivity enthusiasts** who want to gamify their work sessions and maintain awareness of their activity patterns
+- **Remote workers** seeking to track and optimize their daily computer usage habits
+- **Linux power users** running Hyprland who want deep integration with their window manager
+- **Self-improvement focused individuals** who benefit from real-time feedback and progress tracking
+- **Teams or individuals** who want to monitor productivity trends over time through detailed analytics
+
+## Core Functionality
+
+The system provides:
+
+- **Real-time activity detection** that monitors window focus, application usage, and user interaction patterns
+- **Intelligent idle detection** that distinguishes between productive pauses and actual inactivity
+- **XP-style notifications** that provide immediate feedback and motivation
+- **Web-based dashboard** for viewing detailed analytics, trends, and historical data
+- **Configurable monitoring** with customizable thresholds and notification preferences
+- **Database persistence** for long-term tracking and analysis
+- **Zoom integration** for detecting video conferencing sessions
+
+## Use Cases
+
+- Track daily productivity patterns and identify peak performance hours
+- Gamify work sessions to maintain motivation during long coding or writing sessions
+- Monitor break patterns to ensure healthy work-life balance
+- Generate productivity reports for personal reflection or team accountability
+- Integrate with existing workflow tools through the web API
+- Maintain awareness of screen time and application usage distribution
+
+## Technical Architecture
+
+Built with Dart for cross-platform compatibility and performance, featuring:
+- Modular architecture with clean interfaces for extensibility
+- Comprehensive testing suite including simulation capabilities
+- Configuration management for personalized setups
+- Web server for dashboard access and API endpoints
+- Database integration for persistent data storage
+
+This application is particularly well-suited for developers, writers, designers, and other knowledge workers who spend significant time at their computers and want to optimize their productivity through data-driven insights and positive reinforcement.