Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added installation information for oh-my-zsh #174

Merged
merged 1 commit into from
Mar 23, 2023
Merged

docs: added installation information for oh-my-zsh #174

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 22 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
[version-badge]: https://img.shields.io/github/tag/b4b4r07/enhancd.svg
[version-link]: https://github.com/b4b4r07/enhancd/releases

[active-badge]: https://masterminds.github.io/stability/active.svg
[active-link]: https://masterminds.github.io/stability/active.html

[active-link]: https://masterminds.github.io/stability/active.html
[awk-link]: http://pubs.opengroup.org/onlinepubs/9699919799/utilities/awk.html
[license-link]: https://b4b4r07.mit-license.org

Expand Down Expand Up @@ -69,7 +67,6 @@ Thanks to this mechanism, the user can intuitively and easily change the directo
- Fish version
- Because of how fish piping works, it's not possible to pipe to cd like : `ls / | cd`


### Fuzzy search

You can fuzzy-search a directory name you want to run `cd`. For example, a word "text" is expand to "test" and "txt".
Expand Down Expand Up @@ -191,7 +188,6 @@ When moving to the parent directory, the current directory is removed from the c

</details>


### Enhancd complete (fish)

On fish shell, you can use `alt+f` to trigger `enhancd` when typing a command, the selected item will be appended to the commandline
Expand All @@ -216,15 +212,15 @@ Using CLI package manager "[afx](https://github.com/b4b4r07/afx)". YAML for the

```yaml
github:
- name: b4b4r07/enhancd
description: A next-generation cd command with your interactive filter
owner: b4b4r07
repo: enhancd
plugin:
env:
ENHANCD_FILTER: fzf --height 25% --reverse --ansi:fzy
sources:
- init.sh
- name: b4b4r07/enhancd
description: A next-generation cd command with your interactive filter
owner: b4b4r07
repo: enhancd
plugin:
env:
ENHANCD_FILTER: fzf --height 25% --reverse --ansi:fzy
sources:
- init.sh
```

then,
Expand Down Expand Up @@ -267,6 +263,18 @@ Also if you use zsh as your shell, you can install this via [zplug](https://gith
zplug "b4b4r07/enhancd", use:init.sh
```

You can also use it with [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh):

```bash
git clone https://github.com/b4b4r07/enhancd.git $ZSH_CUSTOM/plugins/enhancd
```

and then load as a plugin in your `.zshrc`:

```bash
plugins+=(enhancd)
```

### Fish

#### System Requirements
Expand Down