diff --git a/README.md b/README.md index a3382be..6078375 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Get Playdate SDK -This GitHub Action delivers specified [Playdate] SDK. +drawing +This GitHub Action delivers specified [Playdate SDK][Playdate]. [Playdate]: https://play.date/dev/#cardSDK @@ -12,20 +13,29 @@ This GitHub Action delivers specified [Playdate] SDK. ## Usage Example -Download the latest version of dove +Install the latest version of Playdate SDK ```yaml - name: Install Playdate SDK id: playdate - uses: pd-rs/get-playdate-sdk@0.1.4 + uses: pd-rs/get-playdate-sdk@0.1.6 with: - # possible values: version x.x.x or "latest" - version: latest + version: 2.0.0 # possible values: version `x.x.x` or `latest` - name: usage run: | - echo "SDK root: $PLAYDATE_SDK_PATH" - echo "SDK root: ${{ steps.playdate.outputs.root }}" + echo "SDK path env: $PLAYDATE_SDK_PATH" + echo "SDK root out: ${{ steps.playdate.outputs.root }}" echo "SDK version: ${{ steps.playdate.outputs.version }}" - pdc --version + pdc --version # because SDK/bin already in PATH ``` + +## Supported platforms + +- macOS +- Linux +- Windows + +Note: for Windows there's [winget][] is used as source for specified SDK version, and as just installer-helper for `latest` version + +[winget]: https://github.com/idleberg/winget-pkgs/tree/master/manifests/p/Panic/PlaydateSDK