Files
telescope.nvim/README.md
2020-08-27 09:37:25 -04:00

54 lines
1019 B
Markdown

# telescope.nvim
Gaze deeply into unknown regions using the power of the moon.
![Example](./media/simple_rg_v1.gif)
## Installation
```vim
Plug 'nvim-lua/popup.nvim'
Plug 'nvim-lua/plenary.nvim'
Plug 'nvim-lua/telescope.nvim'
```
## Usage
(I will write a longer description later about how to create each of the objects described in Pipeline)
There is currently a fuzzy finder for git files builtin:
```
require('telescope').builtin.git_files()
```
## Goals
### Pipeline Different Objects
(Please note, this section is still in progress)
"finder":
- executable: rg, git ls-files, ...
- things in lua already
- vim things
"picker":
- fzf
- sk
- does this always need to be fuzzy?
- you'll map what you want to do with vimscript / lua mappings
"previewer":
- sometimes built-in
- sometimes a lua callback
As an example, you could pipe your inputs into fzf, and then it can sort them for you.
fzf:
- have a list of inputs
- i have a prompt/things people typed
- instantly return the stuff via stdout