From 86fc391f8cd18ba2227dd00b48b1746de89341a8 Mon Sep 17 00:00:00 2001
From: David McKissick <dwm0816@outlook.com>
Date: Mon, 1 Oct 2018 03:37:59 -0700
Subject: iwhois: add README (#7176)

---
 plugins/iwhois/README.md         | 24 ++++++++++++++++++++++++
 plugins/iwhois/iwhois.plugin.zsh |  3 ---
 2 files changed, 24 insertions(+), 3 deletions(-)
 create mode 100644 plugins/iwhois/README.md

diff --git a/plugins/iwhois/README.md b/plugins/iwhois/README.md
new file mode 100644
index 000000000..1626b8524
--- /dev/null
+++ b/plugins/iwhois/README.md
@@ -0,0 +1,24 @@
+# iwhois
+
+Provides a whois command with a more accurate and up-to-date list of whois servers
+using CNAMES, via [whois.geek.nz](https://github.com/iwantmyname/whois.geek.nz).
+
+To use it, add iwhois to the plugins array of your zshrc file:
+```
+plugins=(... iwhois)
+```
+
+### Usage
+
+The plugin defines the function `iwhois` that takes a domain name as an argument:
+
+```
+$ iwhois github.com
+   Domain Name: GITHUB.COM
+   Registry Domain ID: 1264983250_DOMAIN_COM-VRSN
+   Registrar WHOIS Server: whois.markmonitor.com
+   Registrar URL: http://www.markmonitor.com
+   Updated Date: 2017-06-26T16:02:39Z
+   Creation Date: 2007-10-09T18:20:50Z
+   ...
+```
diff --git a/plugins/iwhois/iwhois.plugin.zsh b/plugins/iwhois/iwhois.plugin.zsh
index 38790bf28..22a75eec1 100644
--- a/plugins/iwhois/iwhois.plugin.zsh
+++ b/plugins/iwhois/iwhois.plugin.zsh
@@ -1,6 +1,3 @@
-# provide a whois command with a more accurate and up to date list of whois
-# servers using CNAMES via whois.geek.nz
-
 function iwhois() {
     resolver="whois.geek.nz"
     tld=`echo ${@: -1} | awk -F "." '{print $NF}'`
-- 
cgit v1.2.3-70-g09d2