From 498db209133475de66179502cf4486ddfdcc3f0b Mon Sep 17 00:00:00 2001 From: agoodshort Date: Thu, 28 Dec 2023 18:21:33 +0000 Subject: [PATCH] docs: added screen recording Update README.md Update README.md Update README.md --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 67f361f..a2f9c83 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,14 @@ A customizable Telescope extension to list the git submodules of your current project and interact with them through the git TUI of your choice. + + ## Features - List the git submodules of the currently opened project - Preview the files changes for each submodule directly in Telescope - Run the git TUI (or command) of your choice when selecting a submodule in Telescope -- Bypass Telescope if only one repo/submodule should be displayed +- Bypass Telescope if only one repo/submodule would be displayed in Telescope ## Installation @@ -33,17 +35,17 @@ return { The extension comes with the following defaults: ```lua - require("telescope").setup({ - extensions = { - git_submodules = { - git_cmd = "lazygit", - terminal_id = 9, - }, - }, - }) +require("telescope").setup({ + extensions = { + git_submodules = { + git_cmd = "lazygit", + terminal_id = 9, + }, + }, +}) ``` -### Extension Spec +### Extension Specs | Property | Type | Default Value | Description | |-------------|---------|---------------|----------------------------------|