Browse Source

recommend peernames (#78)

* recommend peernames

* add peerName to recommended fields in README
ansuz 7 years ago
parent
commit
f1665e9870
3 changed files with 4 additions and 3 deletions
  1. 2 1
      README.md
  2. 1 1
      tests.js
  3. 1 1
      tests.py

+ 2 - 1
README.md

@@ -37,7 +37,8 @@ We have tried to standardize the structure of the actual credential files, as su
   + publicKey
   + contact (a means of contacting the operator)
 * The following fields are not yet required, but are recommended:
-  + gpg, listing your 16 character pgp fingerprint (no spaces)
+  + gpg, listing your 16 character pgp fingerprint (all caps, no spaces)
+  + peerName, a human-readable name for the node
 * credentials should be formatted such that:
   - indentation uses four spaces
   - the file ends with a newline character.

+ 1 - 1
tests.js

@@ -37,7 +37,7 @@ if (credsWithDns.length) {
 */
 
 var requiredFields = ['password', 'publicKey', 'contact'];
-var recommendedFields = ['gpg'];
+var recommendedFields = ['gpg', 'peerName'];
 
 var insufficientFields = Peers.filter(function (x, p) {
     var problem = false;

+ 1 - 1
tests.py

@@ -5,7 +5,7 @@ import os
 import sys
 
 REQUIRED_FIELDS = ['publicKey', 'password', 'contact']
-RECOMMENDED_FIELDS = ['gpg']
+RECOMMENDED_FIELDS = ['gpg', 'peerName']
 
 RED = '\x1b[01;31m'
 GREEN = '\x1b[01;32m'