commit 6f49a05286efb9aee25ceb3840a0f6a306c966a4 from: mtmn date: Fri Jun 19 11:55:03 2026 UTC docs: install instead of build commit - 40cb58189a29d8b347ced25f731c5de194405bf8 commit + 6f49a05286efb9aee25ceb3840a0f6a306c966a4 blob - e8e915a1027fed98278a434fd194720909dc6ba5 blob + 7ef4368ff9c21b787ea032ac231b49b3725f4dd1 --- README.md +++ README.md @@ -10,18 +10,18 @@ A command-line tool that displays football scores and * Filter matches by team * Support for multiple leagues (Premier League, Championship, La Liga, Champions League) -## Building +## Installation -To build the project, run: +To install scores, run: ```sh -cargo build --release +cargo install --path . ``` ## Usage ```sh -./target/release/scores [OPTIONS] +scores [OPTIONS] ``` ### Options @@ -35,7 +35,7 @@ cargo build --release ### Leagues -* `epl`: Premier League (default) +* `epl`: Premier League * `efl`: Championship * `laliga`: La Liga * `ucl`: Champions League @@ -43,24 +43,24 @@ cargo build --release ### Example ```sh -# List all matches across every competition (default) -./target/release/scores -t +# List all matches across every competition +scores -t # Show upcoming Premier League matches -./target/release/scores -l epl -t +scores -l epl -t # Show Premier League table -./target/release/scores -s -t +scores -s -t # List all matches involving Arsenal across every competition -./target/release/scores -f arsenal -t +scores -f arsenal -t # Show upcoming Arsenal matches in the Premier League -./target/release/scores -l epl -f arsenal -t +scores -l epl -f arsenal -t # Show La Liga standings -./target/release/scores -s -l laliga -t +scores -s -l laliga -t # Show upcoming Champions League matches -./target/release/scores -l ucl -t +scores -l ucl -t ```