diff --git a/README.md b/README.md index bb42451..04f3852 100644 --- a/README.md +++ b/README.md @@ -1,94 +1,80 @@ -# forgit +
+ Utility tool for using git interactively. Powered by junegunn/fzf. +
- -[](https://wfxr.mit-license.org/2017) + -`forgit` is a utility tool powered by fzf for using git interactively. +This tool is designed to help you use git more efficiently. +It's **lightweight** and **easy to use**. -## Installation +### 📥 Installation *Make sure you have [`fzf`](https://github.com/junegunn/fzf) installed.* -### Try Online +``` zsh +# for zplug +zplug 'wfxr/forgit' -Run the following command in your shell to try `forgit` without installing: +# for zgen +zgen load 'wfxr/forgit' -##### Bash and ZSH +# for antigen +antigen bundle 'wfxr/forgit' + +# manually +# Clone the repository and source it in your shell's rc file. +``` + +You can run the following command to try `forgit` without installing: ``` bash -source <(curl -Ss https://raw.githubusercontent.com/wfxr/forgit/master/forgit.plugin.zsh) -``` -##### Fish 3.0 (NOTE: 3.1 is not currently supported) -``` fish -source (curl -Ss https://raw.githubusercontent.com/wfxr/forgit/master/forgit.plugin.fish | psub) +# for bash / zsh +source <(curl -s https://raw.githubusercontent.com/wfxr/forgit/master/forgit.plugin.zsh) +# for fish +source (curl -s 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' -``` +*NOTE: `fish` 3.1 is not currently supported. (see [issue #87](https://github.com/wfxr/forgit/issues/87))* -### [Zgen](https://github.com/tarjoilija/zgen) -``` zsh -zgen load 'wfxr/forgit' -``` +### 📝 Features -### [Antigen](https://github.com/zsh-users/antigen) -``` zsh -antigen bundle 'wfxr/forgit' -``` - -### Manual Installation - -Download and source `forgit.plugin.zsh`, `forgit.plugin.sh`, or `forgit.plugin.fish` in your shell config. - -## Commands - -### ga - -Interactive `git add` selector +- **Interactive `git add` selector** (`ga`)  -### glo - -Interactive `git log` viewer +- **Interactive `git log` viewer** (`glo`)  *The log graph can be disabled by option `FORGIT_LOG_GRAPH_ENABLE` (see discuss in [issue #71](https://github.com/wfxr/forgit/issues/71)).* -### gi - -Interactive `.gitignore` generator +- **Interactive `.gitignore` generator** (`gi`)  -### gd +- **Interactive `git diff` viewer** (`gd`) -Interactive `git diff` viewer +- **Interactive `git reset HEAD