Update documentation

[d4t4king]

Update documentation/guides on GitHub to reflect changes in gem v1.0.0.

add_ip is deprecated, use include_ip; add_asset is deprecated, use include_asset; etc.

I had a client that was functioning normally with v0.9.8(?), and now does not work with 1.0.0, and I'm not quite sure how to fix it.

[sgreen-r7]

We can update the documentation, but in the meantime hopefully this helps:

include_asset can be used exactly the same as add_asset

Did you mean add_ip_range instead of add_ip? That also should be exactly the same when updating to include_ip_range

[d4t4king]

The code itself sends deprecation messages when using the deprecated methods (this is good). I was also able to find documentation listing the specific changes between 0.9.8 and 1.0.0 (also good).

Although probably not clear in my original issue submission, the guides and walk-thru's on how to use the client still use the deprecated methods and objects. Example: https://github.com/rapid7/nexpose-client/wiki/Using-Sites

Following the steps in the above example gives deprecation warnings, or outright failures (in the case of my_site.assets). So it is these basic walk-throughs that need to be updated to reflect the changes in v1.0.0.

HTH.

[gschneider-r7]

Woops, I focused on a few specific deprecated methods to add the warning, and forgot about all of the others I think.

I'll add more deprecation warnings where appropriate and update the wiki this week.

[gschneider-r7]

I went through and updated a lot of the wiki pages to be more up to date regarding Nexpose::Site methods and syntax highlighting. Next step: Update the example scripts to work with current gem version.