From c455473ad8daa3f8879677e6cc8dcc10550e12c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Sat, 25 Jan 2020 21:34:22 +0100 Subject: [PATCH] Tweak README, improve usage docs --- README.md | 42 +++++++++++++++++++++++------------------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 6c2ade6b..b7e1ac79 100644 --- a/README.md +++ b/README.md @@ -10,19 +10,23 @@ Usage ``` sh $ hub clone rtomayko/tilt - -# expands to: #=> git clone git://github.com/rtomayko/tilt.git + +# if you prefer HTTPS to git/SSH protocols: +$ git config --global hub.protocol https +$ hub clone rtomayko/tilt +#=> git clone https://github.com/rtomayko/tilt.git ``` -hub can be safely [aliased](#aliasing) as `git` so you can type `$ git -` in the shell and get all the usual `hub` features. +See [usage examples](https://hub.github.com/#developer) or the [full reference +documentation](https://hub.github.com/hub.1.html) to see all available commands +and flags. -See [Usage documentation](https://hub.github.com/hub.1.html) for the list of all -commands and their arguments. +hub can also be used to make shell scripts that [directly interact with the +GitHub API](https://hub.github.com/#scripting). -hub can also be used to make shell scripts that [manually interface with the -GitHub API](https://hub.github.com/hub-api.1.html). +hub can be safely [aliased](#aliasing) as `git`, so you can type `$ git +` in the shell and have it expanded with `hub` features. Installation ------------ @@ -41,11 +45,14 @@ FreeBSD | [pkg(8)](http://man.freebsd.org/pkg/8) | `pkg install hub` Debian | [apt(8)](https://manpages.debian.org/buster/apt/apt.8.en.html) | `sudo apt install hub` Ubuntu | [Snap](https://snapcraft.io) | `snap install hub --classic` +Packages other than Homebrew are community-maintained (thank you!) and they +are not guaranteed to match the [latest hub release][latest]. Check `hub +version` after installing a community package. + #### Standalone -`hub` can be easily installed as an executable. Download the latest -[compiled binaries](https://github.com/github/hub/releases) and put it anywhere -in your executable path. +`hub` can be easily installed as an executable. Download the [latest +binary][latest] for your system and put it anywhere in your executable path. #### GitHub Actions @@ -139,18 +146,15 @@ New-Item -Type file -Force $PROFILE ### Shell tab-completion -hub repository contains tab-completion scripts for bash, zsh and fish. +hub repository contains [tab-completion scripts](./etc) for bash, zsh and fish. These scripts complement existing completion scripts that ship with git. -[Installation instructions](etc) - -* [hub bash completion](https://github.com/github/hub/blob/master/etc/hub.bash_completion.sh) -* [hub zsh completion](https://github.com/github/hub/blob/master/etc/hub.zsh_completion) -* [hub fish completion](https://github.com/github/hub/blob/master/etc/hub.fish_completion) - Meta ---- -* Home: * Bugs: * Authors: +* Our [Code of Conduct](https://github.com/github/hub/blob/master/CODE_OF_CONDUCT.md) + + +[latest]: https://github.com/github/hub/releases/latest -- GitLab