refactor(config): renamed property

BREAKING CHANGE: Property `terminal_count` is renamed to `terminal_id` for clarity

README.md

@@ -1,13 +1,13 @@
 # telescope-git-submodule.nvim
 
-A customizable telescope extension to list the git submodules of your current project and interact with them through the git TUI of your choice.
+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 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
+- 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
 
 ## Installation
 
@@ -30,21 +30,30 @@ return {
 
 ## Configuration
 
+The extension comes with the following defaults:
+
 ```lua
   require("telescope").setup({
   	extensions = {
   		git_submodules = {
   			git_cmd = "lazygit",
-  			terminal_count = 9,
+  			terminal_id = 9,
   		},
   	},
   })
 ```
 
+### Extension Spec
+
+| Property    | Type    | Default Value | Description                      |
+|-------------|---------|---------------|----------------------------------|
+| git_cmd     | string? | "lazygit"     | `git` TUI command of your choice |
+| terminal_id | number? | 9             | Terminal ID toggleterm will use  |
+
 ## Roadmap
 
-- [ ] Use the terminal plugin of your choice
 - [ ] 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))
 
 ## Acknowledgements
 

lua/telescope/_extensions/git_submodules.lua

@@ -9,7 +9,7 @@ local Terminal = require("toggleterm.terminal").Terminal
 
 local setup_opts = {
 	git_cmd = "lazygit",
-	terminal_count = 9,
+	terminal_id = 9,
 }
 
 -- Mention the pointer in the unception thing
@@ -23,7 +23,7 @@ local function open_git_tool(opts, selection)
 		close_on_exit = true,
 		hidden = true,
 		direction = "float",
-		count = opts.terminal_count,
+		count = opts.terminal_id,
 	})
 
 	if selection == dir_name then