From 45d21f662f62108e8e65d77d3acc1821b74514dd Mon Sep 17 00:00:00 2001 From: rockerBOO Date: Thu, 10 Sep 2020 16:00:17 -0400 Subject: [PATCH] docs: Clarify full example explaination --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9c2c253..060a82d 100644 --- a/README.md +++ b/README.md @@ -112,9 +112,13 @@ nnoremap :lua require'telescope.builtin'.find_files{} nnoremap gr lua require'telescope.builtin'.lsp_references{ shorten_path = true } ``` -* Make the paths full size -* Bind `` for a common mapping to find files. Using `telescope.builtin.git_files` is better in git directories, a toggle can be programmed in to detect if it's a git directory. -* Bind `gr` to find references in LSP. `telescope.builtin.lsp_workspace_symbols` and `telescope.builtin.lsp_document_symbols` are also good to bind for LSP. +What this does: + +* Make the paths full size by default. On LSP references we are shortening paths. +* Bind `` for a common mapping to find files. + - Using `telescope.builtin.git_files` is better in git directories. You can make a toggle to detect if it's a git directory. +* Bind `gr` to find references in LSP. + - `telescope.builtin.lsp_workspace_symbols` and `telescope.builtin.lsp_document_symbols` are also good to bind for LSP. ## Mappings