Skip to content

Commit

Permalink
docs: added requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
agoodshort committed Dec 28, 2023
1 parent 498db20 commit 7f4971b
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ return {
}
```

### Requirements

- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
- [toggleterm.nvim](https://github.com/akinsho/toggleterm.nvim)
- `git`

## Configuration

The extension comes with the following defaults:
Expand All @@ -49,13 +55,13 @@ require("telescope").setup({

| Property | Type | Default Value | Description |
|-------------|---------|---------------|----------------------------------|
| git_cmd | string? | "lazygit" | `git` TUI command of your choice |
| git_cmd | string? | "lazygit" | git TUI command of your choice |
| terminal_id | number? | 9 | Terminal ID toggleterm will use |

## Roadmap

- [ ] Keymap to trigger `:DiffView` for the highlighted submodule
- [ ] If there is interest, support additional terminal plugins (e.g., [nvim-terminal](https://github.com/s1n7ax/nvim-terminal))
- [ ] Support additional terminal plugins (e.g., [nvim-terminal](https://github.com/s1n7ax/nvim-terminal))

## Acknowledgements

Expand Down

0 comments on commit 7f4971b

Please sign in to comment.