diff --git a/README.md b/README.md index 3d28de1..5865565 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ -# GitHub Actions for flyctl +# Automate Fly.io app deployment -This action wraps the flyctl CLI tool to allow deploying and managing fly apps. We recommend using the `setup-flyctl` action which runs outside of Docker for speed and flexibility. +This action wraps the [Fly.io CLI](https://github.com/superfly/flyctl). Use it to deploy or manage your Fly.io application via [Github Actions events](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows). ## Usage for Deployment > > > Tip >
-> For production deployments, we recommend [pinning to a specific version](#pin-to-a-specific-fly-version) of flyctl to avoid changes in `flyctl` behavior affecting your deployment. +> +> For production deployments, [pin flyctl to a specific version][pinning] to avoid unexpected behavior in edge releases. +[pinning]: #pin-to-a-specific-version-of-flyctl ```yaml name: Deploy to Fly @@ -31,7 +33,7 @@ jobs: ```yaml - uses: superfly/flyctl-actions/setup-flyctl@master with: - version: 0.0.308 + version: 0.0.462 ``` ### Running one-off scripts