diff --git a/README.md b/README.md index 8ec9372..5ae4c7b 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,6 @@ [![crates.io](https://img.shields.io/crates/v/fzf-make?style=flatflat-square)](https://crates.io/crates/fzf-make) [![Crates.io Total Downloads](https://img.shields.io/crates/d/fzf-make)](https://crates.io/crates/fzf-make) -

- [English] - [Deutsch] - [Français] -

- @@ -109,6 +103,27 @@ Whether `package.json` and `yarn.lock` are in the current directory. | `fzf-make --help` / `fzf-make help` | Show help | | `fzf-make --version` / `fzf-make -v` / `fzf-make version` | Show version | +## Example Aliases +To simplify the usage of `fzf-make`, you can define aliases in your shell configuration. Below is an example configuration that works for most shells (bash, zsh, fish, etc.): + +```sh +alias fm='fzf-make' +alias fr='fzf-make repeat' +alias fh='fzf-make history' +``` +### Setting Up +1. Add the above lines to your shell's configuration file: +* For bash: `~/.bashrc` +* For zsh: `~/.zshrc` +* For fish: `~/.config/fish/config.fish` (use alias syntax as shown above) +1. Reload your shell configuration: +bash/zsh: `source ~/.bashrc` or `source ~/.zshrc` +fish: `source ~/.config/fish/config.fish` +### Example Usage +* `fm`: Launch fzf-make to select and run a target. +* `fr`: Repeat the last executed command. +* `fh`: Open fzf-make with the history pane focused. + # 💻 Development 1. Clone this repository 1. Change the codes