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.

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

Update readme with demo and images #3

Merged
merged 5 commits into from
Jan 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,14 @@ Welcome to `fish-fzf`, an unopinionated fzf functions for your Fish shell. Bind
- `_fzf_directory_picker` - Directory picker with fzf.
- `_fzf_file_picker` - File picker with fzf.

<img src="./assets/demo.gif" alt="demo" width="100%"></img>

> I don't like to have unused keymaps that comes with most plugins. That's why `fish-fzf` exists.

## Roadmap

- [ ] New function for live grep
- [ ] Test suite

## Installation

Expand Down Expand Up @@ -76,6 +79,8 @@ source /path/to/_fzf_preview_name.fish

### 1. Command History Search

![command history search](./assets/command-history.png)

- Search and select commands from your command history using fzf.
- Replace the current command line with the selected command.
- Optionally, execute the selected command immediately.
Expand All @@ -91,6 +96,8 @@ _fzf_cmd_history [--allow-execute] [--prompt-name <custom_prompt>]

### 2. Directory Picker

![directory picker](./assets/directory-picker.png)

- Navigate and select directories using fzf.
- Optionally, change the current directory or replace the current token with the selected directory path.
- Supports recursive depth and custom prompts.
Expand All @@ -108,6 +115,8 @@ _fzf_directory_picker [--allow-cd] [--recursive-depth <depth>] [--prompt-name <c

### 3. File Picker

![file picker](./assets/file-picker.png)

- Browse and select files and directories using fzf.
- By default, it respects .gitignore and you can turn `--show-hidden-files` for searching all files.
- Optionally, open the selected file in your preferred editor or replace the current token with the selected file path.
Expand Down
Binary file added assets/command-history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/directory-picker.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/file-picker.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.