From d66624df8e16a497cef73deb095ca105119935a8 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Thu, 28 Sep 2017 13:30:03 -0600 Subject: [PATCH] add new bins to README --- README.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 3a6d494..b8ce807 100644 --- a/README.md +++ b/README.md @@ -92,27 +92,24 @@ Usage * CLI * API -**CLI** +### CLI Usage -You can work directly from `node_modules/dns-suite`: +When installed globally you can use these commands: -```bash -pushd node_modules/dns-suite/ +``` +dns-parse.js [out.json] # parses a saved DNS packet to JSON +dns-pack.js [out.bin] # packs a JSON DNS packet to binary +dns-test.js # convert a packet back and forth to test reciprocity of the packer and parser +mdns-capture.js [startnum] # listen and save all mDNS packets, numbering by sequence of arrival ``` -Parsing a saved packet +You can also access them directly from `node_modules/dns-suite` in a project: ```bash -# example -# node bin/dns-parse.js -node bin/dns-parse.js samples/a-0.mdns.bin +node node_modules/dns-suite/bin/dns-parse.js node_modules/dns-suite/samples/a-0.mdns.bin ``` -You can also parse a saved packet from the `native-dns-packet` directory. -these test packets have the binary for each record type and what it's parsed output -should be. - -**Library** +### Library API * `DNSPacket.parse(nodeOrArrayBuffer)` returns json (as shown above) * `DNSPacket.pack(packet)` returns ArrayBuffer (browser and node)