Add getting started instructions to README

WATonomous · Oct 6, 2024 · a6eae69 · a6eae69
1 parent d04f0c4
commit a6eae69
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,12 @@ A tool for generating traces from GitHub Actions. The generated traces are compa
 
 ## Getting started
 
+1. Download the `.whl` file from the [latest release](https://github.com/WATonomous/github-actions-tracing/releases/latest).
+2. Install the wheel: `pip install <path_to_file.whl>`
+3. Run the CLI: `gatrace`
+
+## Development
+
 ```bash
 # Install dependencies
 pdm sync --dev