Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.84 KB

README.md

File metadata and controls

33 lines (22 loc) · 1.84 KB

NBA Live: A TUI tool to view live game data

Consumer Usage

As of version 1.0.0, the brew package is only available for Mac ARM OS users

Installation

  1. brew tap udaypatel1/nba
  2. brew install nba

Get Started

  1. Clone the repository git clone https://github.com/udaypatel1/nba-live-rust.git
  2. Install Rust to compile the code with Cargo
  3. Run cargo --version to make sure Rust is installed properly
  4. Execute cargo run to build the binary and run the tool

Contributions

  • Feel free to clone and contribute! You can make a branch and submit a PR for review
  • Full JSON data endpoint can be found here

Todo List

  • Add a color crate to stylize the output
  • Add proper CLI support with clap or other tooling to allow for future customizations
  • Create a better visual output of score printouts (boxed? grid? centered? maybe behind a flag?)
  • Allow for and pre-build cross-platform builds in target (x86_64 MacOS, Windows, Linux)
  • Establish a proper Release Branch to create releases for version management
  • Package Release Branch state and setup code for Homebrew public forum
  • Make a similar tool for MLB with this