docs: change the api format

declancm · Jun 28, 2024 · e77666a · e77666a
1 parent 182ec91
commit e77666a
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -134,9 +134,9 @@ require("cinnamon").setup {
 
 ### Description
 
-`require("cinnamon").scroll(command, options?)`
+`require("cinnamon").scroll({command}, {options})`
 
-* `command` - Can be any of the following:
+* `{command}` __(string|function)__ Can be any of the following:
   * Normal mode movement command
 
     ```lua
@@ -157,7 +157,7 @@ require("cinnamon").setup {
     end)
     ```
 
-* `options` - An optional table to overwrite options from the configuration table.
+* `{options}` __(table?)__ An optional table to overwrite options from the configuration table.
 
     ```lua
     require("cinnamon").scroll("<C-]>", { delay = 3 })