Net_PublicSuffix README
=======================

Net_PublicSuffix is a php class designed to facilitate access to the
public suffix list (see http://publicsuffix.org/).

Its primary interface is Net_PublicSuffix::registered_domain($d),
which determines the publicly registerable part of DNS label $d.

For example:

-------------------
 require_once('Net/PublicSuffix.php');

 $a = Net_PublicSuffix::registered_domain("www.example.com");
 $b = Net_PublicSuffix::registered_domain("www.monkeys.example.co.uk");

 // $a should be "example.com"
 // $b should be "example.co.uk"
-------------------


Note that the module depends heavily on the existence of a local copy
of the public suffix list, which it assumes to be in the filesystem
at:

 /usr/share/publicsuffix/effective_tld_names.dat

On debian systems, you should be able to get this by installing the
"publicsuffix" package.

I haven't yet bothered to get this module into PEAR properly.  If
anyone wants to help do that, please let me know.

 -- Daniel Kahn Gillmor <dkg@fifthhorseman.net>
