README.md in read_source-0.2.3 vs README.md in read_source-0.2.4

- old
+ new

@@ -87,9 +87,37 @@ NOTES: * If the source code is written in C then the `read_source` and `vim` methods only return nil. * If the file is in `GEM_HOME` path then VIM opens it in read only mode. +## VIM + +We now support VIM servers and can open code directly into your existing VIM session(s). If you've started +a VIM server with the name of "VIM" then any time you call the `vim` method it will open in there **unless** +you choose to specify another servername as a parameter to `vim`. + +#### Start a VIM server with +```ruby +# A default server +vim --servername VIM + +# An alternate server +vim --servername SOMENAME +``` + +Then to open the code in VIM you would do: + +```ruby +# If a server is named VIM (or else it will close current Ruby session and open vim in this terminal). +Gem::BasicSpecification.instance_method(:base_dir=).vim + +# Using a named server +Gem::BasicSpecification.instance_method(:base_dir=).vim 'SOMENAME' +``` + +This way you can keep your ruby code running and open the code in an existing VIM instance. + + ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).