From 30fe1050e750695a9eb54b9bdee3f110db89d3db Mon Sep 17 00:00:00 2001 From: Mingzhe Yang <51149822+mei28@users.noreply.github.com> Date: Sat, 14 Dec 2024 09:04:03 +0900 Subject: [PATCH] docs(readme): add "Example aliases" to README (#395) * add: `aliase examples` * fix: change the section's position. * fix --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 8ec9372..402dd79 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,15 @@ 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' +``` + # 💻 Development 1. Clone this repository 1. Change the codes