summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Cleberg <[email protected]>2026-04-15 22:33:52 -0500
committerChristian Cleberg <[email protected]>2026-04-15 22:33:52 -0500
commitb542a36c072c353e9f3ba23c0fec99e55da8289a (patch)
treea16de4a3775fc168eb20faedfc8702a8f89f6acd
parent4bc78764487dbc6a084502e866bfc3d67f4dbcbc (diff)
downloadnba-scores-b542a36c072c353e9f3ba23c0fec99e55da8289a.tar.gz
nba-scores-b542a36c072c353e9f3ba23c0fec99e55da8289a.tar.bz2
nba-scores-b542a36c072c353e9f3ba23c0fec99e55da8289a.zip
update README
-rw-r--r--README.md76
-rw-r--r--screenshots/preview.pngbin0 -> 1763188 bytes
2 files changed, 58 insertions, 18 deletions
diff --git a/README.md b/README.md
index 67ee760..1a5ca75 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,18 @@
# NBA
-NBA is a simple Python package that provides you with a quick and easy
-command-line interface to current NBA scores and standings.
+![](./screenshots/preview.png)
-See the [Installation](#installation) & [Usage](#usage) sections below
-for more information.
+NBA is a Python package that provides a command-line interface to current NBA
+scores, standings, statistical leaders, playoff picture, and live box scores.
+It supports both a static one-shot mode and an interactive TUI with
+auto-refresh.
# Table of Contents
- [Installation](#installation)
- [Usage](#usage)
+ - [Interactive TUI](#interactive-tui)
+ - [Static output](#static-output)
- [Contributing](#contributing)
# Installation
@@ -24,33 +27,70 @@ pipx install nba-scores
## Manual
-To run the script locally, run the following commands:
-
```shell
git clone https://git.cleberg.net/nba-scores.git
cd nba-scores
-pipx install .
+uv sync
```
-![Installation](./screenshots/installation.png)
-
# Usage
[Back to top](#table-of-contents)
-All commands can be passed to the program with the following template:
-`nba <ARGUMENT>`
+## Interactive TUI
+
+Launch the full interactive terminal UI:
+
+```shell
+nba --tui
+```
+
+Optional flags:
+
+| Flag | Description |
+|--------------------|--------------------------------------------------------|
+| `--tui` | Launch the interactive TUI |
+| `--scores` | Open TUI on the Scores tab (default) |
+| `--standings` | Open TUI on the Standings tab |
+| `--refresh N` | Auto-refresh interval in seconds (default: 60, min: 10)|
+
+### TUI tabs
+
+| Tab | Key | Description |
+|-----------------|-----|----------------------------------------------------------|
+| Scores | `s` | Today's games with live scores and status |
+| Standings | `t` | East / West conference standings, side by side |
+| Leaders | `l` | Top 25 players by stat category |
+| Playoff Picture | `p` | Conference seeding with clinch and elimination status |
+| Box Score | `b` | Per-player live stats for a selected game |
+
+### TUI key bindings
+
+| Key | Action |
+|---------|------------------------------------------------|
+| `1`–`9` | Load box score for game N from the Scores tab |
+| `,` | Cycle to the previous leaders stat category |
+| `.` | Cycle to the next leaders stat category |
+| `r` | Refresh all data immediately |
+| `q` | Quit |
+
+### Leaders stat categories
+
+Cycles through: Points, Rebounds, Assists, Steals, Blocks, Efficiency, FG%, FT%, 3P%
+
+## Static output
+
+Print scores or standings directly to the terminal without launching the TUI:
| Argument | Shortcut | Description |
|---------------|----------|-----------------------------------|
-| `--scores` | `-sc` | Show today's scoreboard |
-| `--standings` | `-st` | Show current conference standings |
-
-Scores:
-![Scores](./screenshots/scores.png)
+| `--scores` | `-sc` | Print today's scoreboard |
+| `--standings` | `-st` | Print current conference standings|
-Standings:
-![Standings](./screenshots/standings.png)
+```shell
+nba --scores
+nba --standings
+```
# Contributing
diff --git a/screenshots/preview.png b/screenshots/preview.png
new file mode 100644
index 0000000..bd0f707
--- /dev/null
+++ b/screenshots/preview.png
Binary files differ