Browse files

Starting with some basic documentation

  • Loading branch information...
1 parent c49b6f5 commit 6949606779e187e211d243565d05d3140044aefe @weppos committed Jul 26, 2009
Showing with 18 additions and 1 deletion.
  1. +18 −1 README.rdoc
19 README.rdoc
@@ -1,3 +1,20 @@
= Whois
-Whois is a pure Ruby, platform-indipendent WHOIS client.
+Whois is a pure Ruby WHOIS client.
+It is a os-independent library and doesn't require external C libraries or GEMS: it is a 100% Ruby software with all the advantages and disadvantages that it involves.
+This software was developed to power RoboDomain and, despite it has been using in a production environment since July 2009, it should not be considered production-ready yet. It is currently in its beta stage.
+An extensive test suite is available to verify the library correctness but you must be aware that registrant might change Whois interfaces without notice and at any time causing queries to specific hosts to stop working.
+== Acknowledgments
+This library is largely inspired by other notable Whois projects, most of all the Debian Whois library written and mainained by Marco D'Itri. Other good ideas and design decisions come from the PERL Net::DRI package.
+I would lie if I say I'm completely unaware of the other Ruby Whois projects. Before starting this Ruby Whois library I deeply investigated the available resources and, despite none of them was a good candidate for a refactoring, some of them expose a really cool API.
+They didn't directly influence this library or any design decision, but they have been a really interesting code-reading.
+The parser architecture (yet to come) has been inspired by the "PHPWhois": project. The authors puts lot of effort to create whois-specific parsers normalizing the different responses in a single tree-based structure. So far, this is the only one opensource project that offers such this feature in all the programming language ecosystem.
+Despite I spent weeks reading source code from the available whois libraries, Ruby Whois has been built from scratch trying to focus on long-term maintainability and flexibility and cannot be considered a Ruby port of any of other existing Whois libraries.

0 comments on commit 6949606

Please sign in to comment.