scores

commit 6f49a05286efb9aee25ceb3840a0f6a306c966a4
parent 40cb58189a29d8b347ced25f731c5de194405bf8
Author: mtmn <miro@haravara.org>
Date:   Fri, 19 Jun 2026 13:55:03 +0200

docs: install instead of build

Diffstat:
M
README.md
 | 
26
+++++++++++++-------------

1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
@@ -10,18 +10,18 @@ A command-line tool that displays football scores and league standings from foot
 * 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 <TOKEN>
+# List all matches across every competition
+scores -t <TOKEN>
 
 # Show upcoming Premier League matches
-./target/release/scores -l epl -t <TOKEN>
+scores -l epl -t <TOKEN>
 
 # Show Premier League table
-./target/release/scores -s -t <TOKEN>
+scores -s -t <TOKEN>
 
 # List all matches involving Arsenal across every competition
-./target/release/scores -f arsenal -t <TOKEN>
+scores -f arsenal -t <TOKEN>
 
 # Show upcoming Arsenal matches in the Premier League
-./target/release/scores -l epl -f arsenal -t <TOKEN>
+scores -l epl -f arsenal -t <TOKEN>
 
 # Show La Liga standings
-./target/release/scores -s -l laliga -t <TOKEN>
+scores -s -l laliga -t <TOKEN>
 
 # Show upcoming Champions League matches
-./target/release/scores -l ucl -t <TOKEN>
+scores -l ucl -t <TOKEN>
 ```