Permalink
Browse files

readme madness

  • Loading branch information...
1 parent a8ff60f commit 880e52c77fcb9fd218edc78b1a8b4dc510711ff9 @mjpearson committed Dec 11, 2011
Showing with 6 additions and 3 deletions.
  1. +6 −3 README.md
View
@@ -1,18 +1,21 @@
-## tldtools
+# tldtools
This module provides TLD domain extraction and resolution services.
-Installation
+## Installation
npm install tldtools
-Usage
+## Usage
var tldtools = require('tldtools');
### tldtools.extract(fqdn)
Extracts tld, domain and subdomain parts from the provided fqdn (supports FQDNs names and URIs).
+
+Based on John Kurkowski's tldextract python library.
+
Returns an object keyed by
* tld - top level domain (com, gov.uk etc)

0 comments on commit 880e52c

Please sign in to comment.