vopher icon indicating copy to clipboard operation
vopher copied to clipboard

README needs description of vopher

Open jhillyerd opened this issue 8 years ago • 2 comments

The README would be more helpful if it included a 'What is It' section with a paragraph or two on what vopher is and why someone would want to use it.

jhillyerd avatar Jan 04 '18 21:01 jhillyerd

You mean something like https://github.com/mgumz/vopher#sample-session … but more obvious in the header/title section?

something like https://2hoch5.com/f/vopher-cast-2018-01-07.m4v ?

mgumz avatar Jan 07 '18 13:01 mgumz

(my opinion) Videos and GIFs are great, when I know what I'm looking at, but there should be some text to set the stage before that.

Ideally longer than "Acquire vim-plugins the gopher-way." The gopher-way means something entirely different outside of the Go community.

I think the Why?? section of your FAQ is closer to what I was thinking... I haven't used vopher, but maybe something like:

  • Manage vim plugins without installing git
  • Use vopher fetch to try out new plugins without modifying your vimrc
  • Lock plugins to known good versions
  • Easily view commit log of plugins with available updates

jhillyerd avatar Jan 07 '18 15:01 jhillyerd

I have added sentences at the start of the README.md. maybe over time i ll further tweak it.

Thanks for careing.

mgumz avatar Oct 06 '22 21:10 mgumz