Please explain that you cannot configure your plugin with Vimscript

[adamency]

My understanding from reading through your Readme and your doc is that it is only possible to configure your plugin in Lua. If I'm right, could you please add a line in your readme and doc to mention this in the beginning, in order to prevent other people (like me) reading the doc for quite some time before realizing this ?

Thank you for your work btw :)

Edit: I've seen the

lua << EOF
...
EOF

trick, but mentioning something about this in the beginning would make it much clearer to Nvim users using old school config

[adamency]

Also, if you wouldn't mind also explaining in the Readme that the constant augends listed are not activated by default (and &&/|| not even existing as an alias) ? It would prevent misleading people into thinking the plugin does not work with our nvim config and trying to troubleshoot it when it's only that the augend is not activated.

[monaqa]

The default augends are clearly stated in the README.

If you don't specify any settings, the following augends is set as the value of the default group.

• augend.integer.alias.decimal
• augend.integer.alias.hex
• augend.date.alias["%Y/%m/%d"]
• augend.date.alias["%Y-%m-%d"]
• augend.date.alias["%m/%d"]
• augend.date.alias["%H:%M"]
• augend.constant.alias.ja_weekday_full

dial.nvim does not aim to be "usable without reading the manual or help, without writing any configuration". But if you find the explanation confusing, PR is welcome.

Note that we generally do not add content that is explicitly stated in other documents. For example, how to write Lua in Vim script is specified in Neovim help (:h :lua-heredoc), and there is no need to explain it in the README of dial.nvim. If we start explaining it, we will have to explain everything about Neovim.