From 190b4525cef34c16872564a32938d70399f0205e Mon Sep 17 00:00:00 2001 From: edfig Date: Mon, 8 Sep 2025 18:00:09 +0200 Subject: [PATCH] Updating readme --- README.md | 32 +++++--------------------------- 1 file changed, 5 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 97ad2ef..0a54589 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ **Your Fantasy Football Command Center** -*Track all your leagues, matchups, and players in one sleek dashboard* +*Track all your leagues, matchups, and players in one dashboard* [![Python](https://img.shields.io/badge/Python-3.8+-blue.svg)](https://python.org) [![Flask](https://img.shields.io/badge/Flask-2.3.3-green.svg)](https://flask.palletsprojects.com/) @@ -16,16 +16,16 @@ ## 🚀 What is GameTime? -GameTime is your all-in-one fantasy football dashboard that connects to Sleeper and ESPN to give you the ultimate game day experience. See all your leagues, matchups, and live scores in one beautiful interface. +GameTime is your all-in-one fantasy football dashboard that connects to your Sleeper account to give you an overview of every league, every player, over a calendar view. ### ✨ Features - 📊 **Multi-League Dashboard** - View all your Sleeper leagues at once -- 🔴 **Live Score Updates** - Real-time score refreshes during game day +- 🔴 **Live Score Updates** - Real-time per-league score for your matchup and your players - 📅 **NFL Schedule Integration** - See when your players are playing - 🌙 **Dark/Light Theme** - Switch themes for day or night viewing - 📱 **Mobile Responsive** - Looks great on all devices -- 🐳 **Docker Ready** - Easy deployment with containers +- 🐳 **Container Ready** - Easy deployment with containers for self-hosting ## 🏃‍♂️ Quick Start @@ -54,29 +54,7 @@ docker-compose up -d 1. **Enter your Sleeper username** on the homepage 2. **View your dashboard** - see all leagues and current week matchups 3. **Navigate weeks** - check past weeks or look ahead -4. **Live updates** - scores refresh automatically during games -5. **Theme switching** - toggle between light and dark modes - -## 🛠 Tech Stack - -- **Backend**: Flask (Python) -- **APIs**: Sleeper API, ESPN API -- **Frontend**: HTML, CSS, JavaScript -- **Deployment**: Docker + Docker Compose - -## 📁 Project Structure - -``` -gametime/ -├── app.py # Main Flask application -├── config.py # App configuration -├── services/ # API integrations -│ ├── sleeper_api.py # Sleeper API client -│ └── espn_api.py # ESPN API client -├── templates/ # HTML templates -├── static/ # CSS and assets -└── ContainerFile # Docker build config -``` +4. **Theme switching** - toggle between light and dark modes ## 🤝 Contributing