From fd64dd259abcae370ffcbc61bea9df542a35c1e1 Mon Sep 17 00:00:00 2001 From: "P. Barrett Little" Date: Tue, 10 Sep 2024 10:04:15 -0400 Subject: [PATCH] docs: Update README with launch monitor and output info Expand README to include details on supported launch monitor (MLM2Pro) and output format (Shot Pattern). This provides clarity for users on compatibility and data export options. Also simplify the contributing guidelines by removing the redundant checkout step. --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5c5ef14..c444d4f 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,15 @@ Albatross is a specialized tool designed for processing and analyzing golf shot - Normalize club types (e.g., "3 wood" -> "3W") - Determine shot types (Tee or Approach) - Calculate median target distances for each club type -- Export processed data to CSV +- Export processed data to CSV in Shot Pattern format + +## Launch Monitor Support + +Currently, Albatross supports the [MLM2Pro](https://rapsodo.com/pages/mlm2pro-golf-simulator) launch monitor. If you need support for additional launch monitors, please open an issue on our GitHub repository. + +## Output Format + +Albatross currently outputs processed data in the [Shot Pattern](https://shotpattern.app/) format. This is the default and only output format available. ## Packages @@ -97,11 +105,10 @@ This will run all tests in the project, including unit tests and end-to-end test ## Contributing 1. Fork it -2. Checkout the `main` branch (`git checkout -b develop`) -3. Create your feature branch (`git checkout -b my-new-feature`) -4. Sign and commit your changes (`git commit -sam 'Add some feature'`) -5. Push to the branch (`git push origin my-new-feature`) -6. Create new Pull Request +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Sign and commit your changes (`git commit -sam 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create new Pull Request ## License