The linked post is not that long. The readme in the linked project happens to be longer, but it's clearly because the author put tables of keymap bindings in the readme.

It's what I'd hope a well-written readme should look like, I think.