Renamed 'ip' command and variable to 'guestip'

README.md

@@ -1,9 +1,13 @@
 # vagrant-guestip plugin
+This plugin allows obtaining an IP address of a guest machine.
+It's compatible with machines started remotely, i.e. by vSphere or AWS providers.
 
 ## Installation
-
     $ vagrant plugin install vagrant-guestip
 
 ## Usage
+    $ vagrant guestip
 
-    $ vagrant ip
+## Using with TeamCity
+Running the command under JetBrains [TeamCity](https://www.jetbrains.com/teamcity/) build, it creates `VAGRANT_GUESTIP` environment variable which can be referenced by following build scripts.
+**Note:** the variable is added by a [service message](https://confluence.jetbrains.com/display/TCD9/Build+Script+Interaction+with+TeamCity). It requires the command and a build script are placed into separate build steps.

lib/command.rb

@@ -8,7 +8,7 @@ def self.synopsis
       def execute
         with_target_vms(nil, {:single_target=>true}) do |machine|
           ip = machine.guest.capability(:read_ip_address)
-          message = ENV['TEAMCITY_VERSION'] ? "##teamcity[setParameter name='env.VAGRANT_IP' value='#{ip}']" : ip
+          message = ENV['TEAMCITY_VERSION'] ? "##teamcity[setParameter name='env.VAGRANT_GUESTIP' value='#{ip}']" : ip
           @env.ui.info(message)
         end
       end

lib/vagrant-guestip.rb

@@ -3,7 +3,7 @@ module GuestIP
     class Plugin < Vagrant.plugin(2)
       name 'guestip'
 
-      command('ip', primary: false) do
+      command('guestip', primary: false) do
         require_relative 'command'
         Command
       end

vagrant-guestip.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |spec|
   spec.name          = 'vagrant-guestip'
-  spec.version       = '0.1'
+  spec.version       = '0.2'
   spec.authors       = ['Michael Kuzmin']
   spec.email         = ['[email protected]']
-  spec.summary       = 'Vagrant plugin for obtaining IP address of guest machine'
+  spec.summary       = 'Vagrant plugin for obtaining IP address of a guest machine'
   spec.homepage      = 'https://github.com/mkuzmin/vagrant-guestip'
   spec.license       = 'MIT'