From 032c9ddbc63e2316b72792f29845c5d8ae18cb0c Mon Sep 17 00:00:00 2001 From: Amanda Pinsker Date: Tue, 8 Sep 2020 12:12:09 -0400 Subject: [PATCH 1/3] Update README.md --- README.md | 64 ++++++++++++++++--------------------------------------- 1 file changed, 18 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 0981951a4..d0dce345e 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,22 @@ # GitHub CLI -`gh` is GitHub on the command line, and it's now available in beta. It brings pull requests, issues, and other GitHub concepts to -the terminal next to where you are already working with `git` and your code. +`gh` is GitHub on the command line. It brings pull requests, issues, and other GitHub concepts to the terminal next to where you are already working with `git` and your code. ![screenshot of gh pr status](https://user-images.githubusercontent.com/98482/84171218-327e7a80-aa40-11ea-8cd1-5177fc2d0e72.png) ## Availability -While in beta, GitHub CLI is available for repos hosted on GitHub.com only. It currently does not support repositories hosted on GitHub Enterprise Server or other hosting providers. We are planning on adding support for GitHub Enterprise Server after GitHub CLI is out of beta (likely towards the end of 2020), and we want to ensure that the API endpoints we use are more widely available for GHES versions that most GitHub customers are on. +GitHub CLI is available for repos hosted on GitHub.com and GitHub Enterprise Server 2.20+. It is available to install on MacOS, Windows, and Linux. ## 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][]. -## Usage - -- `gh pr [status, list, view, checkout, create]` -- `gh issue [status, list, view, create]` -- `gh repo [view, create, clone, fork]` -- `gh config [get, set]` -- `gh help` ## Documentation Read the [official docs][] for more information. -## Comparison with hub - -For many years, [hub][] was the unofficial GitHub CLI tool. `gh` is a new project that helps us explore -what an official GitHub CLI tool can look like with a fundamentally different design. While both -tools bring GitHub to the terminal, `hub` behaves as a proxy to `git`, and `gh` is a standalone -tool. Check out our [more detailed explanation][gh-vs-hub] to learn more. @@ -42,31 +28,17 @@ tool. Check out our [more detailed explanation][gh-vs-hub] to learn more. #### Homebrew -Install: - -```bash -brew install gh -``` - -Upgrade: - -```bash -brew upgrade gh -``` +|Install:|Upgrade:| +|---|---| +|`brew install gh`|`brew upgrade gh`| #### MacPorts -Install: +|Install:|Upgrade:| +|---|---| +|`sudo port install gh`|`sudo port selfupdate && sudo port upgrade gh`| -```bash -sudo port install gh -``` -Upgrade: - -```bash -sudo port selfupdate && sudo port upgrade gh -``` ### Linux @@ -93,17 +65,10 @@ scoop update gh #### Chocolatey -Install: +|Install:|Upgrade:| +|---|---| +|`choco install gh`|`choco upgrade gh`| -```powershell -choco install gh -``` - -Upgrade: - -```powershell -choco upgrade gh -``` #### Signed MSI @@ -117,6 +82,13 @@ Download packaged binaries from the [releases page][]. See here on how to [build GitHub CLI from source][build from source]. +## Comparison with hub + +For many years, [hub][] was the unofficial GitHub CLI tool. `gh` is a new project that helps us explore +what an official GitHub CLI tool can look like with a fundamentally different design. While both +tools bring GitHub to the terminal, `hub` behaves as a proxy to `git`, and `gh` is a standalone +tool. Check out our [more detailed explanation][gh-vs-hub] to learn more. + [official docs]: https://cli.github.com/manual [scoop]: https://scoop.sh From e10bbdd24f19ed05ba252d1a38827f9465ec2642 Mon Sep 17 00:00:00 2001 From: Amanda Pinsker Date: Tue, 8 Sep 2020 12:45:07 -0400 Subject: [PATCH 2/3] Flip docs and feedback sections --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d0dce345e..b909217f2 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,15 @@ GitHub CLI is available for repos hosted on GitHub.com and GitHub Enterprise Server 2.20+. It is available to install on MacOS, Windows, and Linux. -## 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][]. - ## Documentation -Read the [official docs][] for more information. +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][]. From 14c4331a5159f6e6f0aa4fed0086159ddb68703e Mon Sep 17 00:00:00 2001 From: Amanda Pinsker Date: Tue, 8 Sep 2020 12:46:45 -0400 Subject: [PATCH 3/3] tweak availability language --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b909217f2..ae3eeb2c9 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ## Availability -GitHub CLI is available for repos hosted on GitHub.com and GitHub Enterprise Server 2.20+. It is available 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