docs and readme

This commit is contained in:
2025-11-16 11:42:47 +00:00
parent 2810642c0d
commit ba60ab41cc
2 changed files with 26 additions and 0 deletions

8
README.md Normal file
View File

@@ -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)

18
docs/SYNTAX.md Normal file
View File

@@ -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/>