From e4380a1cf2f2f678b814b066bd70973e7d5476b4 Mon Sep 17 00:00:00 2001
From: AJ ONeal <aj@daplie.com>
Date: Sat, 25 Feb 2017 13:43:20 -0700
Subject: [PATCH] add README.md

---
 README.md | 96 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 96 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5e80f48
--- /dev/null
+++ b/README.md
@@ -0,0 +1,96 @@
+mdig
+======
+
+multicast dig
+
+Create and capture mDNS query and response packets to disk as binary and/or JSON.
+Options are similar to the Unix `dig` command, but for mDNS.
+
+See also [dig.js](https://git.daplie.com/Daplie/dig.js)
+
+Install with git
+-------
+
+```bash
+# Install the latest of v1.x
+npm install -g 'git+https://git@git.daplie.com/Daplie/mdig.git#v1'
+```
+
+```bash
+# Install exactly v1.0.0
+npm install -g 'git+https://git@git.daplie.com/Daplie/mdig.git#v1.0.0'
+```
+
+Install without git
+-------
+
+Don't have git? Well, you can also bow down to the gods of the centralized, monopolized, concentrated, dictator-net
+(as we like to call it here at Daplie Labs), if that's how you roll:
+
+```bash
+npm install -g mdig
+```
+
+Usage
+-----
+
+### Format
+
+```bash
+mdig [TYPE] <query>
+```
+
+### Example
+
+```bash
+mdig PTR _services._dns-sd._udp.local
+```
+
+### defaults
+
+When run with no options `mdig` will run with these as the default:
+
+```bash
+mdig -p 5353 @224.0.0.251 PTR _services._dns-sd._udp.local +time=3
+```
+
+### Non-standard mDNS
+
+For debugging you may use a non-standard port and address
+
+```bash
+# non-standard port
+mdig -p 1900
+
+# non-standard broadcast address
+mdig @239.255.255.250
+```
+
+### Common Service Types
+
+```
+_ssh._tcp.local
+_sftp-ssh._tcp.local"
+_nfs._tcp.local
+_pdl-datastream._tcp.local
+_printer._tcp.local
+_ipp._tcp.local
+_http._tcp.local
+_apple-mobdev2._tcp.local
+_workstation._tcp.local
+_udisks-ssh._tcp.local
+```
+
+Options
+-------
+
+```
+--debug
+--output <path/to/file>     write query and response(s) to disk with this path prefix (ex: ./samples/dns)
+-t <type> (superfluous)     default ANY (mdns default: PTR)
+-c <class>                  default IN
+-p <port>                   default 53 (mdns default: 5353) (listener is random for DNS and 5353 for mDNS)
+-q <query> (superfluous)    required (ex: daplie.com)
+
++time=<seconds>             Sets the timeout for a query in seconds.
+```