From 781b84c18fbc855ebac2925f6065d3fdbf3112e0 Mon Sep 17 00:00:00 2001 From: Thomas Hunter II Date: Fri, 31 Aug 2018 13:34:37 -0700 Subject: [PATCH] Displaying package name in a few more places To remove any doubt that the name of the package is `node-named`. --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9c5d05e..2b158c5 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,15 @@ Node-named is a lightweight DNS server written in pure javascript. It has limited support for the DNS spec, but aims to implement all of the *common* functionality that is in use today. +## Installing node-named +``` +$ npm install node-named +``` ## Creating a DNS Server ```javascript - var named = require('./lib/index'); + var named = require('node-named'); var server = named.createServer(); var ttl = 300; @@ -28,7 +32,7 @@ functionality that is in use today. node-named provides helper functions for creating DNS records. The records are available under 'named.record.NAME' where NAME is one -of ['A', 'AAAA', 'CNAME', 'SOA', 'MX', 'NS', 'TXT, 'SRV']. It is important to +of `['A', 'AAAA', 'CNAME', 'SOA', 'MX', 'NS', 'TXT, 'SRV']`. It is important to remember that these DNS records are not permanently added to the server. They only exist for the length of the particular request. After that, they are destroyed. This means you have to create your own lookup mechanism.