From ed426376abda1f3f1516b08004b11c17dbfafd32 Mon Sep 17 00:00:00 2001 From: nbe Date: Mon, 7 Aug 2023 07:30:37 +0300 Subject: [PATCH] docs: add description and why --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 60f0ae6..16b9303 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Quick switch between [worktrees](https://git-scm.com/docs/git-worktree) of a git repository. +It preserves the path relative to the root of your repo. In other words, it's the fastest way to go from `worktree1/src/types` to `worktree2/src/types`. + ### Demo https://github.com/thenbe/worktree-welder/assets/33713262/99515c17-832e-4682-913e-6d85169147df @@ -26,3 +28,7 @@ alias ww='worktree-welder && cd $(cat /tmp/worktree-welder)' cd my-project ww ``` + +### Why? + +https://github.com/ajeetdsouza/zoxide/issues/528