From c38003d78b5f9ed793b1c4a7198cc5f175765272 Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Sun, 11 Oct 2020 10:57:04 +0100 Subject: [PATCH 1/3] Improve installation instructions - Mention downloadable binaries for macOS and Linux - Mention Homebrew for Linux - Cleanup whitespace throughout the file --- README.md | 32 +++++++++++++------------------- 1 file changed, 13 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 9c3e25bb2..579291c1d 100644 --- a/README.md +++ b/README.md @@ -8,43 +8,38 @@ GitHub CLI is available for repositories hosted on GitHub.com and GitHub Enterprise Server 2.20+, and to install on macOS, Windows, and Linux. - ## Documentation Read the [official docs][] for usage and more information. - - ## We want your feedback We'd love to hear your feedback about `gh`. If you spot bugs or have features that you'd really like to see in `gh`, please check out the [contributing page][]. - - ## Installation ### macOS -`gh` is available via [Homebrew][] and [MacPorts][]. +`gh` is available via [Homebrew][] and [MacPorts][], and a downloadable binary from the [releases page][]. #### Homebrew -|Install:|Upgrade:| -|---|---| -|`brew install gh`|`brew upgrade gh`| +| Install: | Upgrade: | +| ----------------- | ----------------- | +| `brew install gh` | `brew upgrade gh` | #### MacPorts -|Install:|Upgrade:| -|---|---| -|`sudo port install gh`|`sudo port selfupdate && sudo port upgrade gh`| - - +| Install: | Upgrade: | +| ---------------------- | ---------------------------------------------- | +| `sudo port install gh` | `sudo port selfupdate && sudo port upgrade gh` | ### Linux -See [Linux installation docs](./docs/install_linux.md). +`gh` is available via [Homebrew](#homebrew), and as downloadable binaries (for `i386`, `amd64` and `arm64`) from the [releases page][]. + +For distro-specific installation instructions, see the [Linux installation docs](./docs/install_linux.md). ### Windows @@ -67,10 +62,9 @@ scoop update gh #### Chocolatey -|Install:|Upgrade:| -|---|---| -|`choco install gh`|`choco upgrade gh`| - +| Install: | Upgrade: | +| ------------------ | ------------------ | +| `choco install gh` | `choco upgrade gh` | #### Signed MSI From d29fc16df9cbeb52567e87fdc42ec1c43058e713 Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Mon, 12 Oct 2020 11:57:43 +0100 Subject: [PATCH 2/3] Suggested changes from PR review --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 579291c1d..bf8f74799 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,9 @@ We'd love to hear your feedback about `gh`. If you spot bugs or have features th ### Linux -`gh` is available via [Homebrew](#homebrew), and as downloadable binaries (for `i386`, `amd64` and `arm64`) from the [releases page][]. +`gh` is available via [Homebrew](#homebrew), and as downloadable binaries from the [releases page][]. -For distro-specific installation instructions, see the [Linux installation docs](./docs/install_linux.md). +For more information and distro-specific instructions, see the [Linux installation docs](./docs/install_linux.md). ### Windows From 10e1c5260c6e728b438b66a679be9449f97fccab Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Mon, 12 Oct 2020 13:10:52 +0100 Subject: [PATCH 3/3] Suggested changes from PR review --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bf8f74799..e0600a4fd 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ## Availability -GitHub CLI is available for repositories hosted on GitHub.com and GitHub Enterprise Server 2.20+, and to install on macOS, Windows, and Linux. +GitHub CLI is available for repositories hosted on GitHub.com and GitHub Enterprise Server 2.20+, and to install on macOS, Windows, and Linux. ## Documentation @@ -21,7 +21,7 @@ We'd love to hear your feedback about `gh`. If you spot bugs or have features th ### macOS -`gh` is available via [Homebrew][] and [MacPorts][], and a downloadable binary from the [releases page][]. +`gh` is available via [Homebrew][], [MacPorts][], and as a downloadable binary from the [releases page][]. #### Homebrew