README.org

main
nba-scores/README.org rendered · source · history · blame · raw

44 lines · 1043 bytes

 1#+title: nba
 2
 3* what
 4python package. command-line interface to nba scores, standings,
 5stat leaders, playoff picture, and live box scores. one-shot mode
 6and an interactive tui with auto-refresh.
 7
 8* install
 9#+begin_src sh
10git clone https://git.cleberg.net/nba-scores.git
11cd nba-scores
12pipx install .
13#+end_src
14
15* tui
16#+begin_src sh
17nba --tui
18#+end_src
19
20#+begin_example
21flags:
22- --tui              launch the tui
23- --scores           open on the scores tab (default)
24- --standings        open on the standings tab
25- --refresh N        refresh seconds (default 60, min 10)
26#+end_example
27
28tabs: scores (s), standings (t), leaders (l), playoff picture (p),
29bracket (k), box score (b).
30
31keys: 1-9 load a box score, comma and period cycle leader
32categories, r refresh, q quit.
33
34leader categories: points, rebounds, assists, steals, blocks,
35efficiency, fg%, ft%, 3p%.
36
37* static
38#+begin_src sh
39nba --scores       # -sc, today's scoreboard
40nba --standings    # -st, conference standings
41#+end_src
42
43* contributing
44fork, add features, open a pull request.