diff --git a/README.md b/README.md index 7703899..159f7b0 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,19 @@ ### Try Online -Run the following command in your shell to try `forgit` without installing(for both `bash` and `zsh`): +Run the following command in your shell to try `forgit` without installing: + +##### Bash and ZSH + ``` bash source <(curl -Ss https://raw.githubusercontent.com/wfxr/forgit/master/forgit.plugin.zsh) ``` +##### Fish +``` fish +source (curl -Ss https://raw.githubusercontent.com/wfxr/forgit/master/forgit.plugin.fish | psub) +``` +### Installation using a ZSH Plugin manager ### [Zplug](https://github.com/zplug/zplug) ``` zsh zplug 'wfxr/forgit' @@ -30,9 +38,9 @@ zgen load 'wfxr/forgit' antigen bundle 'wfxr/forgit' ``` -### Manually +### Manual Installation -Download and source `forgit.plugin.zsh` or `forgit.plugin.sh` in your shell config. +Download and source `forgit.plugin.zsh`, `forgit.plugin.sh`, or `forgit.plugin.fish` in your shell config. ## Commands diff --git a/forgit.plugin.zsh b/forgit.plugin.zsh index 40ae1eb..0b9e66e 100755 --- a/forgit.plugin.zsh +++ b/forgit.plugin.zsh @@ -1,4 +1,5 @@ # MIT (c) Wenxuan Zhang +hash fzf > /dev/null 2>&1 || {echo "FZF not found and is requried for forgit" && return 1} forgit::warn() { printf "%b[Warn]%b %s\n" '\e[0;33m' '\e[0m' "$@" >&2; } forgit::info() { printf "%b[Info]%b %s\n" '\e[0;32m' '\e[0m' "$@" >&2; }