senselogic-gson 0.1.5 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +21 -6
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -10,8 +10,7 @@ Granular Structured Object Notation.
10
10
  * File inclusions
11
11
  * UUID and TUID generation
12
12
  * Customizable commands
13
- * Ultra fast parsing
14
- * Based on obscure characters
13
+ * Ultra fast parsing based on obscure Unicode characters
15
14
 
16
15
  ## Sample
17
16
 
@@ -52,7 +51,7 @@ Granular Structured Object Notation.
52
51
  "age":
53
52
  38
54
53
  }
55
- ],
54
+ },
56
55
  "personByIdMap":
57
56
  {
58
57
  "mike":
@@ -76,7 +75,7 @@ Granular Structured Object Notation.
76
75
  "age":
77
76
  38
78
77
  }
79
- },
78
+ ],
80
79
  "escaped":
81
80
  "\u2034",
82
81
  "uuid":
@@ -88,10 +87,26 @@ Granular Structured Object Notation.
88
87
  }
89
88
  ```
90
89
 
90
+ ## Syntax
91
+
92
+ Multiline strings are enclosed between `‴` characters, and use the `‗` character to represent a non-trimmable space:
93
+ ```
94
+ ‴first line
95
+ second line
96
+ third line ‗
97
+ ‗ fourth line
98
+ fifth line‴
99
+ ```
100
+
101
+ Command strings are also enclosed between `‴` characters, but start with a `‼` character:
102
+ * `‴‼#id‴` generates an MD5-based UUID.
103
+ * `‴‼%id‴` generates an MD5-based TUID.
104
+ * `‴‼@path/to/file.gson‴` includes the contents of another GSON file.
105
+
91
106
  ## Limitations
92
107
 
93
- * `‴` must be escaped in string literals.
94
- * `‼` and `‗` can't be used in string literals.
108
+ * The `‴` character must be escaped in string literals.
109
+ * The `‼` and `‗` characters can't be used in multiline string literals.
95
110
 
96
111
  ## Version
97
112
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "senselogic-gson",
3
3
  "description": "Granular Structured Object Notation.",
4
- "version": "0.1.5",
4
+ "version": "0.1.6",
5
5
  "author": "Eric Pelzer <ecstatic.coder@gmail.com>",
6
6
  "license": "LGPL-3.0-only",
7
7
  "repository": {