Skip to content

Commit 0e08eab

Browse files
committed
fix README
1 parent 14527d1 commit 0e08eab

File tree

1 file changed

+27
-26
lines changed

1 file changed

+27
-26
lines changed

README.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,26 @@ Node-named is a lightweight DNS server written in pure javascript. It has
44
limited support for the DNS spec, but aims to implement all of the *common*
55
functionality that is in use today.
66

7-
8-
97
## Creating a DNS Server
10-
```javascript
11-
var named = require('./lib/index');
12-
var server = named.createServer();
13-
var ttl = 300;
14-
15-
server.listen(9999, '127.0.0.1', function() {
16-
console.log('DNS server started on port 9999');
17-
});
18-
19-
server.on('query', function(query) {
20-
var domain = query.name();
21-
console.log('DNS Query: %s', domain)
22-
var target = new named.SOARecord(domain, {serial: 12345});
23-
query.addAnswer(domain, target, ttl);
24-
server.send(query);
25-
});
8+
9+
```js
10+
var named = require('./lib/index');
11+
var server = named.createServer();
12+
var ttl = 300;
13+
14+
server.listen(9999, '127.0.0.1', function() {
15+
console.log('DNS server started on port 9999');
16+
});
17+
18+
server.on('query', function(query) {
19+
var domain = query.name();
20+
console.log('DNS Query: %s', domain)
21+
var target = new named.SOARecord(domain, {serial: 12345});
22+
query.addAnswer(domain, target, ttl);
23+
server.send(query);
24+
});
2625
```
26+
2727
## Creating DNS Records
2828

2929
node-named provides helper functions for creating DNS records.
@@ -32,12 +32,13 @@ of ['A', 'AAAA', 'CNAME', 'SOA', 'MX', 'NS', 'TXT, 'SRV']. It is important to
3232
remember that these DNS records are not permanently added to the server.
3333
They only exist for the length of the particular request. After that, they are
3434
destroyed. This means you have to create your own lookup mechanism.
35-
```javascript
36-
var named = require('node-named');
37-
38-
var soaRecord = new named.SOARecord('example.com', {serial: 201205150000});
39-
console.log(soaRecord);
35+
```js
36+
var named = require('node-named');
37+
38+
var soaRecord = new named.SOARecord('example.com', {serial: 201205150000});
39+
console.log(soaRecord);
4040
```
41+
4142
### Supported Record Types
4243

4344
The following record types are supported
@@ -53,15 +54,15 @@ The following record types are supported
5354

5455
## Logging
5556

56-
node-named uses [http://github.com/trentm/node-bunyan](bunyan) for logging.
57+
node-named uses [bunyan](http://github.com/trentm/node-bunyan) for logging.
5758
It's a lot nicer to use if you npm install bunyan and put the bunyan tool in
5859
your path. Otherwise, you will end up with JSON formatted log output by default.
5960

6061
### Replacing the default logger
6162

6263
You can pass in an alternate logger if you wish. If you do not, then it will use
63-
bunyan by default. Your logger must expose the functions 'info', 'debug',
64-
'warn', 'trace', 'error', and 'notice'.
64+
bunyan by default. Your logger must expose the functions `info`, `debug`,
65+
`warn`, `trace`, `error`, and `notice`.
6566

6667
### TODO
6768

0 commit comments

Comments
 (0)