From 980cf1e8dd351c2b63de121d66642761a2e38a0d Mon Sep 17 00:00:00 2001 From: acevif Date: Wed, 11 Sep 2024 06:44:02 +0900 Subject: [PATCH 1/3] Add installation instructions for zinit to README.md --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index cc5705d..e6da170 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,8 @@ Examples: How to set up ------------- +### Manual + Put the file `git-escape-magic` somewhere in your `$fpath` and add these lines to your `.zshrc`: @@ -62,6 +64,15 @@ these lines to your `.zshrc`: If you are enabling `url-quote-magic`, make sure to load it first and then load `git-escape-magic`. + +### Zinit + +If you are using [Zinit](https://github.com/zdharma-continuum/zinit), +you can load git-escape-magic by adding the following line to your `.zshrc`: +```zsh +zinit snippet https://github.com/knu/zsh-git-escape-magic/blob/master/git-escape-magic +``` + License ------- From 6a7ace8f566e97dbd165d163cf90e075534574d0 Mon Sep 17 00:00:00 2001 From: acevif Date: Thu, 12 Sep 2024 01:39:27 +0900 Subject: [PATCH 2/3] Update branch --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e6da170..3800d96 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ then load `git-escape-magic`. If you are using [Zinit](https://github.com/zdharma-continuum/zinit), you can load git-escape-magic by adding the following line to your `.zshrc`: ```zsh -zinit snippet https://github.com/knu/zsh-git-escape-magic/blob/master/git-escape-magic +zinit snippet https://github.com/knu/zsh-git-escape-magic/blob/main/git-escape-magic ``` License From 3dd9e970f2d6b2657c396ba52475be8b346f346f Mon Sep 17 00:00:00 2001 From: acevif Date: Thu, 12 Sep 2024 01:40:50 +0900 Subject: [PATCH 3/3] Support Zinit Turbo mode This enables delayed loading, resulting in faster startup times. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3800d96..7c30edc 100644 --- a/README.md +++ b/README.md @@ -68,8 +68,9 @@ then load `git-escape-magic`. ### Zinit If you are using [Zinit](https://github.com/zdharma-continuum/zinit), -you can load git-escape-magic by adding the following line to your `.zshrc`: +you can load git-escape-magic by adding following lines to your `.zshrc`: ```zsh +zinit ice wait zinit snippet https://github.com/knu/zsh-git-escape-magic/blob/main/git-escape-magic ```