README.md in whois-2.7.0 vs README.md in whois-3.0.0
- old
+ new
@@ -20,29 +20,27 @@
*Whois* is free software, but it costs money to write, test, and distribute it. You can support the development by sending a donation. **Any amount, even $5, is greatly appreciated**.
## Features
-* Ability to query registry data for [IPv4, IPv6, TLDs, and domain names](http://www.ruby-whois.org/manual/usage.html#usage-objects)
-* Ability to [parse WHOIS responses](http://www.ruby-whois.org/manual/parser.html)
-* Flexible and extensible interface (e.g. You can define [custom servers](http://www.ruby-whois.org/manual/server.html) on the fly)
-* Object oriented design, featuring 10 different design patterns
-* Pure Ruby library, without any external dependency other than Ruby itself
-* Compatible with [Ruby 1.8.7 and greater](http://www.ruby-whois.org/manual/installing.html#installation-requirements), including Ruby 1.9 branch
-* Successfully tested against several [Ruby implementations](http://www.ruby-whois.org/manual/interpreters.html)
+- Ability to query registry data for [IPv4, IPv6, TLDs, and domain names](http://www.ruby-whois.org/manual/usage/#usage-objects)
+- Ability to [parse WHOIS responses](http://www.ruby-whois.org/manual/parser/)
+- Flexible and extensible interface (e.g. You can define [custom servers](http://www.ruby-whois.org/manual/server/) on the fly)
+- Object oriented design, featuring 10 different design patterns
+- Pure Ruby library, without any external dependency other than Ruby itself
+- Successfully tested against several [Ruby implementations](http://www.ruby-whois.org/manual/interpreters/)
## Requirements
-* Ruby >= 1.8.7
+* Ruby >= 1.9.2
-*Whois* >= 1.5 requires Ruby 1.8.7 or newer.
-For older versions of Ruby, see the CHANGELOG.rdoc file.
+For older versions of Ruby, see the [CHANGELOG](CHANGELOG.md) file.
In addition to the standard Ruby interpreter (MRI),
Whois has been successfully tested against several
-[Ruby implementations](http://www.ruby-whois.org/manual/interpreters.html).
+[Ruby implementations](http://www.ruby-whois.org/manual/interpreters/).
## Installation
The best way to install *Whois* is via [RubyGems](https://rubygems.org/).
@@ -50,73 +48,62 @@
$ gem install whois
You might need administrator privileges on your system to install the gem.
-## Upgrade
-
-Install the newer version via RubyGems.
-
- $ gem install whois
-
-Minor and bugfix releases normally won't break backwards-compatibility. You can read the CHANGELOG.md file to learn about the changes in each release.
-
-Read the [Upgrading](http://www.ruby-whois.org/manual/upgrading.html) documentation page for detailed information about incompatible changes and further instructions.
-
-
## Getting Started
-Note. This section covers only the essentials for getting started with the Whois library. The [documentation](http://www.ruby-whois.org/documentation.html) provides a more accurate explanation including tutorials, more examples and technical details about the client/server/record/parser architecture.
+Note. This section covers only the essentials for getting started with the Whois library. The [documentation](http://www.ruby-whois.org/documentation/) provides a more accurate explanation including tutorials, more examples and technical details about the client/server/record/parser architecture.
### Querying the Server
Whois provides the ability to get WHOIS information for TLD, domain names, IPv4 and IPv6 addresses. The client is smart enough to guess the best WHOIS server according to given query, send the request and return the response.
Check out the following examples:
# Domain WHOIS
w = Whois::Client.new
- w.query("google.com")
+ w.lookup("google.com")
# => #<Whois::Record>
# TLD WHOIS
w = Whois::Client.new
- w.query(".com")
+ w.lookup(".com")
# => #<Whois::Record>
# IPv4 WHOIS
w = Whois::Client.new
- w.query("74.125.67.100")
+ w.lookup("74.125.67.100")
# => #<Whois::Record>
# IPv6 WHOIS
w = Whois::Client.new
- w.query("2001:db8::1428:57ab")
+ w.lookup("2001:db8::1428:57ab")
# => #<Whois::Record>
The query method is stateless. For this reason, you can safely re-use the same client instance for multiple queries.
w = Whois::Client.new
- w.query("google.com")
- w.query(".com")
- w.query("74.125.67.100")
- w.query("2001:db8::1428:57ab")
- w.query("google.it")
+ w.lookup("google.com")
+ w.lookup(".com")
+ w.lookup("74.125.67.100")
+ w.lookup("2001:db8::1428:57ab")
+ w.lookup("google.it")
If you just need a WHOIS response and you don't care about a full control of the WHOIS client, the {Whois} module provides an all-in-one method called {Whois.whois}. This is the simplest way to send a WHOIS request.
- Whois.whois("google.com")
+ Whois.lookup("google.com")
# => #<Whois::Record>
Did I mention you can even use blocks?
Whois::Client.new do |w|
- w.query("google.com")
- w.query(".com")
- w.query("74.125.67.100")
- w.query("2001:db8::1428:57ab")
- w.query("google.it")
+ w.lookup("google.com")
+ w.lookup(".com")
+ w.lookup("74.125.67.100")
+ w.lookup("2001:db8::1428:57ab")
+ w.lookup("google.it")
end
### Consuming the Record
Any WHOIS query returns a `Whois::Record`. This object looks like a String, but it's way more powerful.
@@ -158,11 +145,11 @@
w = Whois::Client.new(:timeout => 10)
w.timeout # => 10
w.timeout = 5
w.timeout # => 5
- w.query("google.com")
+ w.lookup("google.com")
## Acknowledgments
First of all, I would like to express my most sincere thanks to Cyril Mougel, the author of the first Ruby Whois gem that has been available since 2007. Cyril has been kind enough to yield me the privilege of using the RubyForge Whois project and the Whois package name to publish this library. To express all my gratitude, the release 0.5.0 and all sub sequential versions of the new Whois up to 0.9.x are 100% compatible with Cyril's Whois.
@@ -194,17 +181,17 @@
## More
- [Homepage](http://www.ruby-whois.org/)
- [Repository](https://github.com/weppos/whois)
-- [Documentation](http://www.ruby-whois.org/documentation.html) - The official documentation, see also the [API Documentation](http://www.ruby-whois.org/api).
+- [Documentation](http://www.ruby-whois.org/documentation/) - The official documentation, see also the [API Documentation](http://www.ruby-whois.org/api).
- [Discussion Group](http://groups.google.com/group/ruby-whois)
## Changelog
See the [CHANGELOG](CHANGELOG.md) file for details.
## License
-Copyright (c) 2009-2012 Simone Carletti. This is Free Software distributed under the MIT license.
+Copyright (c) 2009-2013 Simone Carletti. This is Free Software distributed under the MIT license.