From: Eugene Crosser Date: Tue, 22 Apr 2014 13:57:36 +0000 (+0400) Subject: Beta status, cosmetic update in the doc X-Git-Tag: 0.9.0.0~18 X-Git-Url: http://www.average.org/gitweb/?p=pdns-pipe-nmc.git;a=commitdiff_plain;h=ad3d8d0ca9c8bc5d94d4ea533ebd23b35375a787 Beta status, cosmetic update in the doc --- diff --git a/README.md b/README.md index dd7b171..3780aec 100644 --- a/README.md +++ b/README.md @@ -82,12 +82,12 @@ your resolvers. ## Status -Alpha. It is insufficiently tested, and there are loose ends in the -functionality. For example, 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. +Beta. It is mostly feature-complete, but insufficiently tested. +It implements the data format specification (SPEC.md in the source +distribution) that slightly deviates from the +[official specification](https://wiki.namecoin.info/index.php?title=Domain_Name_Specification). +I am using it to access some of the `.bit` websites and it works +for me. Try at your risk. diff --git a/SPEC.md b/SPEC.md index 5c659b7..a3254ee 100644 --- a/SPEC.md +++ b/SPEC.md @@ -17,8 +17,9 @@ This specification is implemented by the `pdns-pipe-nmc` program. ### `DomObj` Object -`DomObj` either a `String` containing a dotted quad (see Note below), -or a JSON `Map`, with the following attributes, all optional: +`DomObj` is a data structure that is associated with an FQDN. It is +either a `String` containing a dotted quad (see Note below), or a +JSON `Map`, with the following attributes, all optional: | Key | Type | Comment | |-------------|---------------------------------------|--------------------------------------------| @@ -188,7 +189,7 @@ Does not translate into any DNS RR. Contains Tor hidden service address. #### i2p attribute -Does not translate into any DNS RR. Contains an object with three +Does not translate into any DNS RR. It is a JSON Map with three optional String attributes: `"destination"`, `"name"` and `"b32"`. ```