diff --git a/README.md b/README.md index 9014382..7d94344 100644 --- 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 ` +3. Run the CLI: `gatrace` + +## Development + ```bash # Install dependencies pdm sync --dev