From cedfabc4f3067721595a97c6ea1072507a906004 Mon Sep 17 00:00:00 2001 From: ansuz Date: Thu, 19 Nov 2015 11:40:38 -0500 Subject: [PATCH] update README with newline requirement. format all credentials to match --- AS/sg/singapore/weuxel.sing.k | 1 + EU/nl/amsterdam/mrowr.me.k | 1 + EU/nl/amsterdam/weuxel.ams.k | 14 +++++++------- EU/uk/london/ansuz.science.k | 1 + NA/ca/beauharnois/derp.fusion.k | 14 +++++++------- NA/us/newyork/weuxel.usa.k | 14 +++++++------- README.md | 6 ++++-- 7 files changed, 28 insertions(+), 23 deletions(-) diff --git a/AS/sg/singapore/weuxel.sing.k b/AS/sg/singapore/weuxel.sing.k index 918a844..e76c905 100644 --- a/AS/sg/singapore/weuxel.sing.k +++ b/AS/sg/singapore/weuxel.sing.k @@ -5,3 +5,4 @@ "user":"weuxel", "contact": "hype@smash-net.org" } + diff --git a/EU/nl/amsterdam/mrowr.me.k b/EU/nl/amsterdam/mrowr.me.k index 00bae87..6bf29dc 100644 --- a/EU/nl/amsterdam/mrowr.me.k +++ b/EU/nl/amsterdam/mrowr.me.k @@ -4,3 +4,4 @@ "user":"katt", "contact":"oniichan@mrowr.me", } + diff --git a/EU/nl/amsterdam/weuxel.ams.k b/EU/nl/amsterdam/weuxel.ams.k index 88eeb86..e98aeb3 100644 --- a/EU/nl/amsterdam/weuxel.ams.k +++ b/EU/nl/amsterdam/weuxel.ams.k @@ -1,7 +1,7 @@ -"188.226.183.183:43328": - { - "password":"public_access", - "publicKey":"1y1jmqrw4r31jlp6yqmq30067rcp0tsgsdm3cs4k8l33pyfhpwn0.k", - "user":"weuxel", - "contact": "hype@smash-net.org" - } +"188.226.183.183:43328": { + "password":"public_access", + "publicKey":"1y1jmqrw4r31jlp6yqmq30067rcp0tsgsdm3cs4k8l33pyfhpwn0.k", + "user":"weuxel", + "contact": "hype@smash-net.org" +} + diff --git a/EU/uk/london/ansuz.science.k b/EU/uk/london/ansuz.science.k index 946bdd8..15ec4f0 100644 --- a/EU/uk/london/ansuz.science.k +++ b/EU/uk/london/ansuz.science.k @@ -4,3 +4,4 @@ "user":"ansuz", "contact":"ansuz@transitiontech.ca", } + diff --git a/NA/ca/beauharnois/derp.fusion.k b/NA/ca/beauharnois/derp.fusion.k index 2600312..be8831c 100644 --- a/NA/ca/beauharnois/derp.fusion.k +++ b/NA/ca/beauharnois/derp.fusion.k @@ -1,7 +1,7 @@ -"142.4.212.42:1441": - { - "password":"201510034nnmj97n54nby3797xt227lr0538ty4", - "publicKey":"9uf222z95bxd7sgvncdtzr2skgjp7vdr472f7u74pc0zxu0pjxl0.k", - "user": "derp", - "contact": "derp@projectmeshnet.org" - } \ No newline at end of file +"142.4.212.42:1441": { + "password":"201510034nnmj97n54nby3797xt227lr0538ty4", + "publicKey":"9uf222z95bxd7sgvncdtzr2skgjp7vdr472f7u74pc0zxu0pjxl0.k", + "user": "derp", + "contact": "derp@projectmeshnet.org" +} + diff --git a/NA/us/newyork/weuxel.usa.k b/NA/us/newyork/weuxel.usa.k index df4296d..054d90a 100644 --- a/NA/us/newyork/weuxel.usa.k +++ b/NA/us/newyork/weuxel.usa.k @@ -1,7 +1,7 @@ -"192.241.171.154:62718": - { - "password":"public_access", - "publicKey":"q5nhj9kg6ddmk571jb259mct2ljd10z9xvyf05y3hu66wk4qnk20.k", - "user":"weuxel", - "contact": "hype@smash-net.org" - } +"192.241.171.154:62718": { + "password":"public_access", + "publicKey":"q5nhj9kg6ddmk571jb259mct2ljd10z9xvyf05y3hu66wk4qnk20.k", + "user":"weuxel", + "contact": "hype@smash-net.org" +} + diff --git a/README.md b/README.md index 4c32877..a9d69f3 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,14 @@ By following this scheme, we make it possible for users to programmatically find ## JSON formatting -* Your credentials must be [valid JSON](http://jsonlint.com/). +* Your credentials must be [valid JSON](http://jsonlint.com/) when inserted into a block of curly braces `{}` * They should be small enough so as to be inserted into a `cjdroute.conf` **as is** without triggering the [connectTo-overflow bug](https://github.com/hyperboria/docs/blob/master/bugs/connectTo-overflow.md). * They must contain the necessary fields: + ip/port + password + publicKey -* They should also contain a means of contacting the operator +* They should also contain a means of contacting the operator. +* credentials should end with a newline character. ``` @@ -60,6 +61,7 @@ By following this scheme, we make it possible for users to programmatically find "publicKey":"ssxlh80x0bqjfrnbkm1801xsxyd8zd45jkwn1zhlnccqj4hdqun0.k", "peerName":"your-name-goes-here" } + ``` > Note: the snippet above is **not valid json**. It would need to be wrapped in an additional block of curly braces `{ }`