From ba60ab41ccc37cdc5d4bb2d7ce6935f6a3d2281e Mon Sep 17 00:00:00 2001
From: deadvey <deadvey@deadvey.com>
Date: Sun, 16 Nov 2025 11:42:47 +0000
Subject: [PATCH] docs and readme

---
 README.md      |  8 ++++++++
 docs/SYNTAX.md | 18 ++++++++++++++++++
 2 files changed, 26 insertions(+)
 create mode 100644 README.md
 create mode 100644 docs/SYNTAX.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bb78591
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# What?
+NPON (networked pages object notation) is an experimental object syntax<br/>
+For use in serving networked pages over TCP<br/>
+In order to do this, I made a very basic protocol called OTP (NPON object transfer protocol)<br/>
+This transfers the objects over TCP using some specific control characters (32 reserved)<br/>
+
+# NPON syntax
+[syntax](docs/SYNTAX.md)
diff --git a/docs/SYNTAX.md b/docs/SYNTAX.md
new file mode 100644
index 0000000..f7f76b5
--- /dev/null
+++ b/docs/SYNTAX.md
@@ -0,0 +1,18 @@
+This syntax is kinda like JSON<br/>
+But not quite.<br/>
+Here is an example:<br/>
+```
+(index) = {
+    (meta) = {
+        (notation) = "NPON"
+        (version) = '0.1'
+    }
+    (pages) = {
+        :home.npon:
+    }
+}
+```
+as you can see, keys are surrounded by brackets ()<br/>
+strings are surrounded by quotes "" or ''<br/>
+and you can import data from another file with colons ::<br/>
+Additionaly, strings support backslashes if you need quotes within quotes.<br/>