Skip to content

Commit

Permalink
docs: added screen recording
Browse files Browse the repository at this point in the history
Update README.md

Update README.md

Update README.md
  • Loading branch information
agoodshort committed Dec 28, 2023
1 parent 755d708 commit 498db20
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<https://github.com/agoodshort/telescope-git-submodules.nvim/assets/33832653/5d13113f-16a2-40f7-91e4-816827234240>

## 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

Expand All @@ -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 |
|-------------|---------|---------------|----------------------------------|
Expand Down

0 comments on commit 498db20

Please sign in to comment.