summaryrefslogtreecommitdiff
path: root/README.nfo
diff options
context:
space:
mode:
authorChristian Cleberg <[email protected]>2026-08-02 15:29:35 -0500
committerChristian Cleberg <[email protected]>2026-08-02 15:29:35 -0500
commite4a4929d48700f75dd2caeed71bbd0c3f0a5004f (patch)
treef1ee679195870ef54ccc411f6af7b1389753b879 /README.nfo
parentc112ed86bafa47aa2141b626a5592bd06cbc81f6 (diff)
downloadnba-scores-main.tar.gz
nba-scores-main.tar.bz2
nba-scores-main.zip
convert readme to nfo; relicense to 0bsdHEADmain
Diffstat (limited to 'README.nfo')
-rw-r--r--README.nfo42
1 files changed, 42 insertions, 0 deletions
diff --git a/README.nfo b/README.nfo
new file mode 100644
index 0000000..431f2b6
--- /dev/null
+++ b/README.nfo
@@ -0,0 +1,42 @@
+┌──────────────────────────────────────────────────────────────┐
+│ N B A [ KRZ ] krz.sh │
+└──────────────────────────────────────────────────────────────┘
+
+WHAT
+ python package. command-line interface to nba scores, standings,
+ stat leaders, playoff picture, and live box scores. one-shot mode
+ and an interactive tui with auto-refresh.
+
+INSTALL
+ git clone https://git.cleberg.net/nba-scores.git
+ cd nba-scores
+ pipx install .
+
+TUI
+ nba --tui
+
+ flags:
+ - --tui launch the tui
+ - --scores open on the scores tab (default)
+ - --standings open on the standings tab
+ - --refresh N refresh seconds (default 60, min 10)
+
+ tabs: scores (s), standings (t), leaders (l), playoff picture (p),
+ bracket (k), box score (b).
+
+ keys: 1-9 load a box score, comma and period cycle leader
+ categories, r refresh, q quit.
+
+ leader categories: points, rebounds, assists, steals, blocks,
+ efficiency, fg%, ft%, 3p%.
+
+STATIC
+ nba --scores # -sc, today's scoreboard
+ nba --standings # -st, conference standings
+
+CONTRIBUTING
+ fork, add features, open a pull request.
+
+┌──────────────────────────────────────────────────────────────┐
+│ krz.sh │
+└──────────────────────────────────────────────────────────────┘