-
-
Notifications
You must be signed in to change notification settings - Fork 19
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
Comments
I wish the vim version of this plugin explained a bit how it worked too, maybe you could add that as well? |
thanks for the feedback |
Added it to the readme. |
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 :) |
Also you've convinced me to install it now :) |
This is just a picture |
ig I should add links |
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:
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!
The text was updated successfully, but these errors were encountered: