chore: add more docs

Author: towry

README.md

@@ -2,9 +2,7 @@
   <h1 align="center">commit-msg-sg.nvim</h2>
 </p>
 
-<p align="center">
-Write git commit message with AI (sg.nvim).
-</p>
+Write git commit message with AI ([sg.nvim](https://github.com/sourcegraph/sg.nvim), [Cody](https://sourcegraph.com/cody)).
 
 <div align="center">
     > Drag your video (<10MB) here to host it for free on GitHub.
@@ -34,8 +32,34 @@ Snippet
 ```lua
 {
   'towry/commit-msg-sg.nvim',
+  dependencies = {
+    'sourcegraph/sg.nvim',
+  },
+  -- all options are optional, you can leave it as empty table `{}`.
   opts = {
-    -- see doc
+    cwd = function()
+      return vim.uv.cwd()
+    end,
+    -- auto attach on gitcommit filetype.
+    auto_setup_gitcommit = true,
+    -- auto create user command `WriteGitCommitMessage`.
+    auto_setup_command = true,
+    -- callback when AI is started and attached to current buffer. (client, bufnr)
+    -- You can create your own buffer local commands or keymaps in this callback.
+    on_attach = nil,
+    -- Ghost text that will be presenting when AI is working.
+    ghost_text = "Thinking...",
+    -- function to generate prompt string.
+    -- accept a callback that takes input as prompt string.
+    -- prompt_gen = function(callback)
+    --   -- some async operation to generate prompt.
+    --   local generated_prompt_string = 'The prompt string ...'
+    --   callback(error_or_nil, generated_prompt_string)
+    -- end
+    prompt_gen = nil,
+    -- default prompt string if you do not want to use prompt_gen.
+    -- default_prompt = [[Some prompt string ... The diff content is: %s]]
+    default_prompt = nil,
   },
   cmd = { 'WriteGitCommitMessage' },
   ft = 'gitcommit',
@@ -62,11 +86,3 @@ Snippet
 ## ⌨ Contributing
 
 PRs and issues are always welcome. Make sure to provide as much context as possible when opening one.
-
-## 🗞 Wiki
-
-You can find guides and showcase of the plugin on [the Wiki](https://github.com/towry/commit-msg-sg.nvim/wiki)
-
-## 🎭 Motivations
-
-> If alternatives of your plugin exist, you can provide some pros/cons of using yours over the others.

lua/commit-msg-sg/config.lua

@@ -5,14 +5,31 @@ local CommitMsgSg = {}
 --- Default values:
 ---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section)
 CommitMsgSg.options = {
-  ---@type string|function
+  -- Can be string or function that returns cwd.
+  --@type string|function
   cwd = nil,
+  -- auto attach on gitcommit filetype.
   auto_setup_gitcommit = true,
+  -- auto create user command `WriteGitCommitMessage`.
   auto_setup_command = true,
+  -- callback when AI is started and attached to current buffer. (client, bufnr)
+  -- You can create your own buffer local commands or keymaps in this callback.
   on_attach = nil,
   ghost_text = "Thinking...",
-  -- customized function to generate prompt string.
+  -- function to generate prompt string.
+  -- accept a callback that takes input as prompt string.
+  -- ```lua
+  -- prompt_gen = function(callback)
+  --   -- some async operation to generate prompt.
+  --   local generated_prompt_string = 'The prompt string ...'
+  --   callback(error_or_nil, generated_prompt_string)
+  -- end
+  -- ```
   prompt_gen = nil,
+  -- default prompt string if you do not want to use prompt_gen.
+  -- default_prompt = [[Some prompt string ... The diff content is: %s]]
+  -- Note: the staged diff content is generated so you can use it in your prompt to
+  -- add more context.
   default_prompt = nil,
   -- @private
   executor = "sg",

lua/commit-msg-sg/init.lua

@@ -101,7 +101,6 @@ function M.write()
 
   local executor = require("commit-msg-sg.executor")
   gen_snippet(config.options, function(err, snippet)
-    print(snippet)
     if err then
       vim.notify(err, vim.log.levels.ERROR)
       return