From f0641262bd4d4e28dab4effa6cf9d631ab7b5bb9 Mon Sep 17 00:00:00 2001 From: amantahiliani Date: Tue, 3 Mar 2026 00:51:53 -0500 Subject: [PATCH] Added README --- AGENTS.md | 1 + GEMINI.md | 1 + README.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 79 insertions(+) create mode 120000 AGENTS.md create mode 120000 GEMINI.md create mode 100644 README.md diff --git a/AGENTS.md b/AGENTS.md new file mode 120000 index 0000000..681311e --- /dev/null +++ b/AGENTS.md @@ -0,0 +1 @@ +CLAUDE.md \ No newline at end of file diff --git a/GEMINI.md b/GEMINI.md new file mode 120000 index 0000000..681311e --- /dev/null +++ b/GEMINI.md @@ -0,0 +1 @@ +CLAUDE.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..6d884f4 --- /dev/null +++ b/README.md @@ -0,0 +1,77 @@ +# 🏎️ box-box + +![Status-Pre-Beta](https://img.shields.io/badge/Status-Pre--Beta-yellow?style=for-the-badge) + +> "Box, box. Box, box." — Every F1 Race Engineer, ever. + +**⚠️ Disclaimer: This project is currently in a pre-beta state.** Features may be incomplete, and you might encounter bugs as we fine-tune the engine. + +**box-box** is a high-performance Formula 1 Terminal User Interface (TUI) built for fans who live in the command line. Get real-time standings, race calendars, and deep-dive driver stats without ever leaving your terminal. + +![box-box TUI Preview](https://img.shields.io/badge/UI-Bubble%20Tea-00ADD8?style=for-the-badge&logo=go) +![Data-OpenF1](https://img.shields.io/badge/Data-OpenF1-FF1801?style=for-the-badge) + +## ✨ Features + +- 🏆 **Live Standings**: Keep track of the Driver and Constructor Championships. +- 📅 **Race Calendar**: The full 2025 schedule at your fingertips. +- 🏎️ **Race Details**: Deep dive into session results, starting grids, and lap data. +- 👤 **Driver Profiles**: Detailed stats for every driver on the grid. +- 🔌 **Offline-ish**: Fast, lightweight, and powered by the wonderful [OpenF1 API](https://openf1.org). + +## 🚀 Quick Start + +### Prerequisites + +- [Go](https://go.dev/doc/install) 1.21 or higher. + +### Installation + +```bash +# Clone the repository +git clone https://github.com/AmanTahiliani/box-box.git +cd box-box + +# Build and run +go run cmd/main.go +``` + +## 🎮 Controls + +| Key | Action | +| --- | --- | +| `1` | Switch to **Standings** | +| `2` | Switch to **Calendar** | +| `3` | Switch to **Race Details** | +| `4` | Switch to **Drivers** | +| `j`/`↓` | Navigate down | +| `k`/`↑` | Navigate up | +| `enter` | Select/Inspect item | +| `b` | Go back | +| `q` / `ctrl+c` | Exit | + +## 🛠️ Tech Stack + +- **[Bubble Tea](https://github.com/charmbracelet/bubbletea)**: The TUI engine. +- **[Lipgloss](https://github.com/charmbracelet/lipgloss)**: For that sleek F1 styling. +- **[Bubbles](https://github.com/charmbracelet/bubbles)**: Common TUI components. +- **[OpenF1 API](https://api.openf1.org)**: The data source (Free, no API key needed). + +## 🚥 Development + +Want to tinker under the hood? + +```bash +# Run tests +go test ./... + +# View API integration tests (requires internet) +go test -v ./internal/api +``` + +## 📜 License + +MIT © [Aman Tahiliani](https://github.com/AmanTahiliani) + +--- +*Disclaimer: This project is unofficial and not associated with Formula 1 or the FIA in any way.*