From 4d75fe94ca613e99d38bfb5fde66049e85e6950a Mon Sep 17 00:00:00 2001 From: mleku Date: Thu, 30 Jan 2025 08:36:54 +0000 Subject: [PATCH] Create spec.md --- spec.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 spec.md diff --git a/spec.md b/spec.md new file mode 100644 index 0000000..08b57f8 --- /dev/null +++ b/spec.md @@ -0,0 +1,19 @@ +# realy protocol event specification + +JSON is awful, and space inefficient, and complex to parse due to its intolerance of terminal commas and annoying to work with because of its retarded, multi-standards of string escaping. + +Line structured documents are much more readily amenable to human reading and editing, and `\n` is more efficient than `","` as an item separator. Data structures can be much more simply expressed in a similar way as how they are in programming languages. + +It is one of the guiding principles of the Unix philosophy to keep data in plain text, human readable format wherever possible, forcing the interposition of a parser just for humans to read the data adds extra brittleness to a protocol. + +So, this is how realy events look: + +``` +\n +\n +\n +key;value;extra;...\n // zero or more line separated, fields cannot contain a semicolon, end with newline instead of semicolon +content // literally this word on one line +\n + +```