Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README should quickly answer "what does this solve" #12

Closed
dbalatero opened this issue Oct 7, 2021 · 7 comments
Closed

README should quickly answer "what does this solve" #12

dbalatero opened this issue Oct 7, 2021 · 7 comments

Comments

@dbalatero
Copy link

Hi! As quick feedback, the README for this repo makes me want to close Chrome because it's not immediately obvious what this plugin does.

You might want to take another read, but pretend you've never heard of the plugin before.

The repository you link out to (https://github.com/jdhao/better-escape.vim) has a better introduction:

A lot of people have been mapping jk or kj or kk to ESC in order to escape insert mode quickly. However, when we press the first key in these mappings, Vim/Nvim will wait for timeoutlen milliseconds before writing this char to buffer. The apparent lag caused by this behaviour is annoying.

Better-escape.vim is created to help Vim/Nvim users escape insert mode quickly using their customized key combinations, without experiencing the lag.

You should have something like that front and center on this project's README. If don't immediately understand a plugin's purpose when browsing the repo, I will often just close the tab and move on. Get people excited about it!

@dbalatero
Copy link
Author

Better-escape.vim is created to help Vim/Nvim users escape insert mode quickly using their customized key combinations, without experiencing the lag.

I wish the vim version of this plugin explained a bit how it worked too, maybe you could add that as well?

@max397574
Copy link
Owner

thanks for the feedback
heard that already.
I'm working on it

@max397574
Copy link
Owner

Added it to the readme.

@dbalatero
Copy link
Author

Awesome, this looks great!

There's a little bug–it looks like the GIF you added to the README got converted to a PNG somehow, so it's not animating. You might need to reupload/readd it :)

@dbalatero
Copy link
Author

Also you've convinced me to install it now :)

@max397574
Copy link
Owner

This is just a picture
The gifs are below (demo)
This just shows the moment

@max397574
Copy link
Owner

ig I should add links

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants