Beta status, cosmetic update in the doc
authorEugene Crosser <crosser@average.org>
Tue, 22 Apr 2014 13:57:36 +0000 (17:57 +0400)
committerEugene Crosser <crosser@average.org>
Tue, 22 Apr 2014 13:57:36 +0000 (17:57 +0400)
README.md
SPEC.md

index dd7b1711a50f298335db4f608a9092cc82d65387..3780aec274d33fe91aefd253ee2bd297340568c1 100644 (file)
--- 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 5c659b75853cbed01c1c5f7611b8e1152c165383..a3254ee617a1bdd8a372ae9917ea2dc28780cebb 100644 (file)
--- 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"`.
 
 ```