allow "import" to me an array
[pdns-pipe-nmc.git] / README.md
index 2cf634d805b2784c47ca1a60c3a7b87914ab5c83..47fbba57142bce42e22236a0ff93c0ca63b7eacb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,9 +9,9 @@ for offline conversion of namecoin data into BIND zone file.
 
 Unlike those, this project is a single-purpose tool acting as a (real
 time) bridge between [Namecoin](http://namecoin.info/) and DNS.
-[PowerDNS](https://www.powerdns.com/) provides a stable DNS frontend,
-with an easy to implement backend interface. The latter is used in
-this project.
+It is implemented as a `pipe backend` to
+[PowerDNS](https://www.powerdns.com/), which provides stable DNS
+frontend, and has simple backend interface.
 
 ## Building
 
@@ -54,7 +54,10 @@ rpcport=8336
 
 They are the parameters needed to contact the `namecoind` server over
 its JsonRPC interface. With default installation on `localhost`, you
-will only need to specify `password`.
+will only need to specify `rpcpassword`.
+
+Configure your resolvers to use the PowerDns instance for queries in
+the `.bit` zone. This is left as an exercise to the reader.
 
 ## Security Considerations
 
@@ -66,7 +69,7 @@ hackers or ruthless governments from tampering with your queries
 and powerdns responses. There are two possible approaches to
 mitigation of this problem:
 
-* Run `namecoind` and the bridge as close to the consumer as
+* Run namecoind and powerdns as close to the consumer as
 possible: on the same host, or at least on the same network, and
 keep it guarded.
 * I did not try it, but it should be possible to use PowerDNS
@@ -79,9 +82,15 @@ your resolvers.
 
 ## Status
 
-Alpha. It does not handle `SRV` records at all, does not support
-`delegate` (not to mention `import`), provides bogus version in the
-`SOA` record, and is largely untested. Try at your risk.
+Alpha. It is largely untested, and there are loose ends in the
+functionality. For example, `delegate` does not work yet, version in the
+`SOA` record is bogus. Some of the the problems are due to incomplete
+and/or imprecise
+[definition of the domain data format](https://wiki.namecoin.info/index.php?title=Domain_Name_Specification)
+on the wiki. That said, I am using it to access some of the `.bit` websites
+and did not notice anomalies so far.
+
+Try at your risk.
 
 ## Getting the Source
 
@@ -89,7 +98,7 @@ Check the [project homepage](http://www.average.org/pdns-pipe-nmc/).
 
 Git [clone](git://git.average.org/git/pdns-pipe-nmc.git) or
 [browse](http://www.average.org/gitweb/?p=pdns-pipe-nmc.git;a=summary),
-or use [github mirrir](https://github.com/crosser/pdns-pipe-nmc).
+or use [github mirror](https://github.com/crosser/pdns-pipe-nmc).
 
 ## Author