diff options
| author | TJ DeVries <devries.timothyj@gmail.com> | 2020-08-27 22:18:12 -0400 |
|---|---|---|
| committer | TJ DeVries <devries.timothyj@gmail.com> | 2020-08-27 22:18:12 -0400 |
| commit | 02ff322242cb2a738f9df497a99d8632f363e0ad (patch) | |
| tree | da0ee3faa7422fc3521f81b87f08d08d9efcef9c | |
| parent | 7e9f38a87e1dfc5226665e9602e39a900519c732 (diff) | |
Update readme
| -rw-r--r-- | README.md | 18 |
1 files changed, 17 insertions, 1 deletions
@@ -18,10 +18,26 @@ Plug 'nvim-lua/telescope.nvim' There is currently a fuzzy finder for git files builtin: -``` +```lua +-- Fuzzy find over git files in your directory require('telescope.builtin').git_files() + +-- Grep as you type (requires rg currently) +require('telescope.builtin').live_grep() + +-- Use builtin LSP to request references under cursor. Fuzzy find over results. +require('telescope.builtin').lsp_references() ``` +## Status (Unstable API) + +While the underlying API & Infrastructure (A.K.A. Spaghetti Code) is still very much WIP and +will probably change quite a bit, the functions in `builtin` should be relatively stable (as +in, you can report bugs if they don't work, you should be able to keep them around in your config +even if everything inside of those functions is rewritten. They provide pretty simple, easy to use +wrappers over common tasks). + + ## Goals |
