From 02ff322242cb2a738f9df497a99d8632f363e0ad Mon Sep 17 00:00:00 2001 From: TJ DeVries Date: Thu, 27 Aug 2020 22:18:12 -0400 Subject: [PATCH] Update readme --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index be3209a..e7b7639 100644 --- a/README.md +++ b/README.md @@ -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