diff --git a/README.md b/README.md index 2e42063..9685bc3 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ -dns-lint +dns-suite ======== -Fast, lightweight, **pure JavaScript** (ES5.1) implementation for DNS / mDNS. +Fast, lightweight, and easy-to-extend **pure JavaScript** (ES5.1) implementation for DNS / mDNS. Works great in **Web Browsers** and in node.js! Detailed error checking makes it great for * capture -* packing (JSON to DNS) -* parsing (DNS to JSON) +* packing (JSON to DNS/mDNS) +* parsing (DNS/mDNS to JSON) * linting (finding errors in packets) * debugging -**No external dependencies** for modern browsers. Uses `DataView`, `Uint8Array`, `Uint16Array`, and `ArrayBuffer` +**No external dependencies** for node.js or modern browsers. Uses `DataView`, `Uint8Array`, `Uint16Array`, and `ArrayBuffer` Similar API to `dns.js` and `native-dns-packet`. @@ -52,13 +52,13 @@ Install ------- ```bash -npm install git+https://git@git.daplie.com:Daplie/dns-lint +npm install git+https://git@git.daplie.com:Daplie/dns-suite ``` **Test**: ```bash -pushd node_modules/dns-lint +pushd node_modules/dns-suite npm test ``` @@ -68,10 +68,10 @@ Usage **CLI** -You can work directly from `node_modules/dns-lint`: +You can work directly from `node_modules/dns-suite`: ```bash -pushd node_modules/dns-lint/ +pushd node_modules/dns-suite/ ``` Capture mDNS broadcast packets @@ -110,7 +110,7 @@ node.js: var nodeBuffer = fs.readFileSync('./samples/a-0.mdns.bin'); var arrayBuffer = nodeBuffer.buffer; -var dnsjs = require('dns-lint'); +var dnsjs = require('dns-suite'); var packet = dnsjs.unpack(arrayBuffer); console.log(packet); diff --git a/package.json b/package.json index 78db5cf..23964fc 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "dns-lint", + "name": "dns-suite", "version": "1.0.0", "description": "testing dns", "main": "dns.js", @@ -8,7 +8,7 @@ }, "repository": { "type": "git", - "url": "git@git.daplie.com:Daplie/dns-lint.git" + "url": "git@git.daplie.com:Daplie/dns-suite.git" }, "author": "", "license": "(MIT or Apache2)"