README.md Improvement: Make it easy for newbies

[sgon00]

Hi, nvim-surround is a really great and easy tool. But I gave up on it before when I first read the README.md. The mp4 video and the Usage section scared me a lot. The mp4 video does not make things clearer; instead, it makes me even more confused. When I saw ysiw) and ys$", I decided to leave because life is already hard, I don't want to make it even harder.

Luckily, next time when I try to find a replacement when asking chatgpt, it recommended using nvim-surround again with S keyword. Then I did some tests and dived into the doc in more detail. I figured out that nvim-surround was actually very easy.

In visual selection mode,

• S" done.
• St insert tag, done.
• Si put anything, done.

I don't know why the README.md shows the scaries part of the plugin, maybe that is the best way for experts, but not for newbies like me.

Hopefully, the README.md can be improved to inclue the easiest parts so that more people will use it.

[kylechui]

Hi there, thanks for trying nvim-surround out, and even moreso for providing feedback! The README will most likely not change, since its primary goal is to display the primary features/usages of the plugin, which IMO are centered around the normal-mode mappings.

As you discovered, there does exist the S mapping in visual, but I would probably recommend reading a bit of :h motion and :h textobject to really maximize usage of this plugin and its ys/ds/cs mappings.

P.S. Welcome to using Neovim and I hope you won't get too intimidated in the future---we all start somewhere!