Readme usage instructions are not straight forward (to me)

[FichteFoll]

I've had a rather hard time understanding how exactly this plugin works. Things I struggeld most with are:

• is <regex>/<option> the only accepted syntax or would a simple <regex> with a default option suffice?
• How do I escape literal / if I wanted to include them in the regex?
• What are the options available and what is the syntax?

Answers to these questions can mostly be found in the readme, but there is no "quick reference" kind of thing where you'd look up things you are searching for. It took me a while to understand what the f option does for example because I was expecting a list or similar.

Of course, you may disagree with me, but these are my initial thoughts after deciding to finally install this plugin and maybe you can put some use into it.

Edit: A command reference for self-binding would've been appreciated. (example)

---

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

[randy3k]

Thanks for being interested in it. From time to time, I hv wanted to rewrite the read me. I will try to do so. :)

[georgecrawford]

Another quick point - you don't explain what the f option actually stands for.

[FichteFoll]

You mean what it does or what the f should mean?

only the first delimiter is matched, the number after f controls how many delimiter is used.

If the number after f is omitted, only the first delimiter will be matched.

(it matches first n occurences)

"how many delimiter is used" is very poorly worded though.

[georgecrawford]

Yeah, I see the explanation. It's just that l is left, r is right, and f is "how many delimiter is used". Why use f?

[FichteFoll]

(it matches first n occurences)

[randy3k]

Thanks for the replies. I agree that the documentation has to be updated somehow.