From 191c3076f1992e12ff5cb3e58804321e7566e4c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ya=C5=9Far=20Fatih=20Enes=20Yal=C3=A7=C4=B1n?= Date: Sun, 7 Jul 2024 15:24:18 +0300 Subject: [PATCH] Improve README for clarity, consistency, and formatting - Improve heading levels and consistency - Correct minor grammatical errors --- README.md | 60 +++++++++++++++++++++++++++---------------------------- 1 file changed, 29 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index c6274efc23..f4c7179495 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,30 @@ # flyctl -flyctl is a command-line interface for fly.io +flyctl is a command-line interface for fly.io. -Note: Most installations of `flyctl` also alias `flyctl` to `fly` as a command name and this will become the default name in the future. -During the transition, note that where you see `flyctl` as a command it can be replaced with `fly`. +Note: Most installations of `flyctl` also alias `flyctl` to `fly` as a command name, and this will become the default name in the future. During the transition, note that where you see `flyctl` as a command, it can be replaced with `fly`. ## Installation -## Using a Package Manager +### Using a Package Manager #### [Homebrew](https://brew.sh) (macOS, Linux, WSL) ```bash brew install flyctl ``` + To upgrade to the latest version: ```bash brew upgrade flyctl ``` -## Install Script +### Install Script -Download `flyctl` and install into a local bin directory. +Download `flyctl` and install it into a local bin directory. -#### MacOS, Linux, WSL +#### macOS, Linux, WSL Installing the latest version: @@ -46,61 +46,59 @@ curl -L https://fly.io/install.sh | sh -s 0.0.200 #### Windows -Run the Powershell install script: +Run the PowerShell install script: -``` +```powershell iwr https://fly.io/install.ps1 -useb | iex ``` - -## Downloading from GitHub +### Downloading from GitHub Download the appropriate version from the [Releases](https://github.com/superfly/flyctl/releases) page of the `flyctl` GitHub repository. ## Getting Started -1. Sign into your fly account +1. Sign into your Fly account: -```bash -fly auth login -``` + ```bash + fly auth login + ``` -2. List your apps +2. List your apps: -```bash -fly apps list -``` + ```bash + fly apps list + ``` -2. View app status +3. View app status: -```bash -fly status -a {app-name} -``` + ```bash + fly status -a {app-name} + ``` ## App Settings `flyctl` will attempt to use the app name from a `fly.toml` file in the current directory. For example, if the current directory contains this file: - ```bash $ cat fly.toml app: banana ``` -`flyctl` will operate against the `banana` app unless overridden by the -a flag or other app name setting in the command line. +`flyctl` will operate against the `banana` app unless overridden by the `-a` flag or another app name setting in the command line. ## Releases -`flyctl` is automatically released at 3 PM Eastern Standard Time Monday - Thursday. If needed, you can bump a release by running `./scripts/bump_version.sh`. + +`flyctl` is automatically released at 3 PM Eastern Standard Time, Monday - Thursday. If needed, you can bump a release by running `./scripts/bump_version.sh`. ## Building on Windows -There is a simple Powershell script, `winbuild.ps1`, which will run the code generation for the help files, format them, and run a full build, leaving a new binary in the bin directory. +There is a simple PowerShell script, `winbuild.ps1`, which will run the code generation for the help files, format them, and run a full build, leaving a new binary in the bin directory. -## Running from branches on your local machine +## Running from Branches on Your Local Machine -Run `scripts/build-dfly` to build a Docker image from the current branch. Then, use `scripts/dfly` to run it. This assumes you are already -authenticated to Fly in your local environment. +Run `scripts/build-dfly` to build a Docker image from the current branch. Then, use `scripts/dfly` to run it. This assumes you are already authenticated to Fly in your local environment. +## Contributing Guide -## Contributing guide See [CONTRIBUTING.md](./CONTRIBUTING.md)