diff --git a/README.md b/README.md index 64d0806..20c6824 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,49 @@ -# mlblive -mlblive is a CLI tool for retrieving data from Major League Baseball's Stats +# mlbstats +mlbstats is a CLI tool for retrieving data from Major League Baseball's Stats API, including efficient retrieval of live game data. Unofficial documentation on the Stats API can be found [here](https://github.com/toddrob99/MLB-StatsAPI/wiki/Endpoints) (thanks to GitHub user toddrob99 for this resource). ## Usage -mlblive provides sub-commands to query a subset of the Stats API endpoints. As +mlbstats provides sub-commands to query a subset of the Stats API endpoints. As of the time of writing, the sub-commands are: -* `mlblive content` (accesses the `game_content` endpoint) -* `mlblive feed` (accesses the `game` endpoint) -* `mlblive schedule` (accesses the `schedule` endpoint) -* `mlblive standings` (accesses the `standings` endpoint) -* `mlblive subscribe` (accesses the game WebSocket endpoint) +* `mlbstats content` (accesses the `game_content` endpoint) +* `mlbstats feed` (accesses the `game` endpoint) +* `mlbstats schedule` (accesses the `schedule` endpoint) +* `mlbstats standings` (accesses the `standings` endpoint) +* `mlbstats subscribe` (accesses the game WebSocket endpoint) Each sub-command outputs the raw JSON response from the API. This can then be piped into other commands like `jq` for further processing. See [this -repo](https://scm.dairydemon.net/filifa/mlblive-mastodon-scripts) for examples -of how the author use this program for posting live score updates and +repo](https://scm.dairydemon.net/filifa/mlbstats-mastodon-scripts) for examples +of how the author uses this program for posting live score updates and highlights to Mastodon. -Note that mlblive does not provide sub-commands for every endpoint, or flags +Note that mlbstats does not provide sub-commands for every endpoint, or flags for every parameter of every endpoint. The functionality provided was prioritized based on the author's own needs. However, the author has made every effort to make the current functionality's code easy to read, and hopes it will be similarly easy for other developers to extend functionality as needed. ### subscribe sub-command -`mlblive subscribe` provides an efficient way to obtain live data on active MLB -games. Supply the game's PK (which can be retrieved with `mlblive schedule`) to +`mlbstats subscribe` provides an efficient way to obtain live data on active MLB +games. Supply the game's PK (which can be retrieved with `mlbstats schedule`) to receive updates as they happen, without needing to blindly query the `game` endpoint. ### Example -Use `mlblive schedule` to get the game PK(s) for today's Reds game: +Use `mlbstats schedule` to get the game PK(s) for today's Reds game: ``` -mlblive schedule -t cin +mlbstats schedule -t cin ``` Optionally, use `jq` to filter this output to *just* the game PK(s): ``` -mlblive schedule -t cin | jq '.dates[].games[].gamePk' +mlbstats schedule -t cin | jq '.dates[].games[].gamePk' ``` Then, pass a PK to get live updates: ``` -mlblive subscribe -g +mlbstats subscribe -g ``` ## Disclaimer diff --git a/cmd/root.go b/cmd/root.go index 6d6f196..f47fdc9 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -23,7 +23,7 @@ import ( // rootCmd represents the base command when called without any subcommands var rootCmd = &cobra.Command{ - Use: "mlblive", + Use: "mlbstats", Short: "Command line tools for Major League Baseball's Stats API", Long: `Command line tools for Major League Baseball's Stats API.`, }