From a6f06f80847cc084f863bc5f135fac93412ffdb2 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Mon, 9 Mar 2020 19:16:44 -0700 Subject: [PATCH] feat: update README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index d731a3cb6..5344db1ea 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,9 @@ And if you spot bugs or have features that you'd really like to see in `gh`, ple Check out the [docs][] for more information. +## Documentation + +Read the official docs at [https://cli.github.com/manual/](https://cli.github.com/manual/) ## Comparison with hub @@ -109,6 +112,16 @@ $ yay -S github-cli Install a prebuilt binary from the [releases page][] +## Setting an Editor + +For macOS and Linux, `gh` will respect the following environment variables, in this order, based on your OS and shell setup: + +1. `GIT_EDITOR` +2. `VISUAL` +3. `EDITOR` + +On Windows, the editor will currently always be Notepad. + ### [Build from source](/source.md) [docs]: https://cli.github.com/manual