refactor!: key for conformation sound option

README.md

@@ -4,7 +4,7 @@
 <!-- TODO uncomment shields when available in dotfyle.com -->
 <!-- <a href="https://dotfyle.com/plugins/chrisgrieser/nvim-tinygit"><img src="https://dotfyle.com/plugins/chrisgrieser/nvim-tinygit/shield" /></a> -->
 
-Lightweight git client for nvim for quick commits and other quality of life improvements.
+Lightweight and nimble git client for nvim.
 
 `nvim-tinygit` should be considered beta status. It-works-on-my-machine™, but it has not yet been tested by many other users.
 
@@ -101,8 +101,9 @@ local defaultConfig = {
 		closedPR = "🟥",
 	},
 
-	-- confirmation sounds on finished async operations like push
-	confirmationSoundsOnMacOs = true,
+	-- Confirmation sound on finished async operations like push. 
+	-- Currently macOS only.
+	confirmationSound = true,
 }
 ```
 

lua/tinygit.lua

@@ -21,7 +21,7 @@ local defaultConfig = {
 		mergedPR = "🟨",
 		closedPR = "🟥",
 	},
-	confirmationSoundsOnMacOs = true,
+	confirmationSound = true, -- for async commands like push
 }
 
 -- set values if setup call is not run
@@ -75,11 +75,11 @@ local function notInGitRepo()
 	return notInRepo
 end
 
----if on mac, play a sound
+---CAVEAT currently only on macOS
 ---@param soundFilepath string
 local function playSoundMacOS(soundFilepath)
 	local onMacOs = fn.has("macunix") == 1
-	if not onMacOs or not config.confirmationSoundsOnMacOs then return end
+	if not onMacOs or not config.confirmationSound then return end
 	fn.system(("afplay %q &"):format(soundFilepath))
 end