Skip to content

Commit b2a1b59

Browse files
ronibhakta1ronibhakta1
committed
docs: Refine README formatting by adjusting code block indentation and heading structure.
1 parent 3a08bdf commit b2a1b59

1 file changed

Lines changed: 46 additions & 48 deletions

File tree

‎README.md‎

Lines changed: 46 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![npm version](https://img.shields.io/npm/v/zon-format.svg)](https://www.npmjs.com/package/zon-format)
44
[![GitHub stars](https://img.shields.io/github/stars/ZON-Format/zon-TS?style=social)](https://github.com/ZON-Format/zon-TS)
55
[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue.svg)](https://www.typescriptlang.org/)
6-
[![Tests](https://img.shields.io/badge/tests-175%2F175%20passing-brightgreen.svg)](#quality--testing)
6+
[![Tests](https://img.shields.io/badge/tests-205%2F205%20passing-brightgreen.svg)](#quality--testing)
77
[![npm downloads](https://img.shields.io/npm/dm/zon-format?color=red)](https://www.npmjs.com/package/zon-format)
88
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
99

@@ -120,67 +120,67 @@ XML: 3,235 bytes
120120
```
121121
GPT-4o (o200k):
122122
123-
ZON █████████░░░░░░░░░░░ 513 tokens 👑
124-
CSV ██████████░░░░░░░░░░ 534 tokens (+4.1%)
125-
JSON (cmp) ███████████░░░░░░░░░ 589 tokens (+12.9%)
126-
TOON ███████████░░░░░░░░░ 614 tokens (+19.7%)
127-
YAML █████████████░░░░░░░ 728 tokens (+41.9%)
128-
JSON format ████████████████████ 939 tokens (+45.4%)
129-
XML ████████████████████ 1,093 tokens (+113.1%)
123+
ZON █████████░░░░░░░░░░░ 513 tokens 👑
124+
CSV ██████████░░░░░░░░░░ 534 tokens (+4.1%)
125+
JSON (cmp) ███████████░░░░░░░░░ 589 tokens (+12.9%)
126+
TOON ███████████░░░░░░░░░ 614 tokens (+19.7%)
127+
YAML █████████████░░░░░░░ 728 tokens (+41.9%)
128+
JSON format ████████████████████ 939 tokens (+45.4%)
129+
XML ████████████████████ 1,093 tokens (+113.1%)
130130
131131
Claude 3.5 (Anthropic):
132132
133-
CSV ██████████░░░░░░░░░░ 544 tokens 👑
134-
ZON ██████████░░░░░░░░░░ 548 tokens (+0.7%)
135-
TOON ██████████░░░░░░░░░░ 570 tokens (+4.0%)
136-
JSON (cmp) ███████████░░░░░░░░░ 596 tokens (+8.1%)
137-
YAML ████████████░░░░░░░░ 641 tokens (+17.0%)
138-
JSON format ████████████████████ 914 tokens (+40.0%)
139-
XML ████████████████████ 1,104 tokens (+101.5%)
133+
CSV ██████████░░░░░░░░░░ 544 tokens 👑
134+
ZON ██████████░░░░░░░░░░ 548 tokens (+0.7%)
135+
TOON ██████████░░░░░░░░░░ 570 tokens (+4.0%)
136+
JSON (cmp) ███████████░░░░░░░░░ 596 tokens (+8.1%)
137+
YAML ████████████░░░░░░░░ 641 tokens (+17.0%)
138+
JSON format ████████████████████ 914 tokens (+40.0%)
139+
XML ████████████████████ 1,104 tokens (+101.5%)
140140
141141
Llama 3 (Meta):
142142
143-
ZON ██████████░░░░░░░░░░ 696 tokens 👑
144-
CSV ██████████░░░░░░░░░░ 728 tokens (+4.6%)
145-
JSON (cmp) ███████████░░░░░░░░░ 760 tokens (+8.4%)
146-
TOON ███████████░░░░░░░░░ 784 tokens (+12.6%)
147-
YAML █████████████░░░░░░░ 894 tokens (+28.4%)
148-
JSON format ████████████████████ 1,225 tokens (+43.1%)
149-
XML ████████████████████ 1,392 tokens (+100.0%)
143+
ZON ██████████░░░░░░░░░░ 696 tokens 👑
144+
CSV ██████████░░░░░░░░░░ 728 tokens (+4.6%)
145+
JSON (cmp) ███████████░░░░░░░░░ 760 tokens (+8.4%)
146+
TOON ███████████░░░░░░░░░ 784 tokens (+12.6%)
147+
YAML █████████████░░░░░░░ 894 tokens (+28.4%)
148+
JSON format ████████████████████ 1,225 tokens (+43.1%)
149+
XML ████████████████████ 1,392 tokens (+100.0%)
150150
```
151151

152152
#### Large Complex Nested Dataset
153153

154154
```
155155
gpt-4o (o200k):
156156
157-
ZON █████████░░░░░░░░░░░ 143,661 tokens 👑
158-
CSV ██████████░░░░░░░░░░ 164,919 tokens (+14.8%)
159-
JSON (cmp) ███████████░░░░░░░░░ 188,604 tokens (+23.8%)
160-
TOON █████████████░░░░░░░ 224,940 tokens (+56.6%)
161-
YAML █████████████░░░░░░░ 224,938 tokens (+56.6%)
162-
JSON format ████████████████████ 284,132 tokens (+97.8%)
163-
XML ████████████████████ 335,239 tokens (+133.4%)
157+
ZON █████████░░░░░░░░░░░ 143,661 tokens 👑
158+
CSV ██████████░░░░░░░░░░ 164,919 tokens (+14.8%)
159+
JSON (cmp) ███████████░░░░░░░░░ 188,604 tokens (+23.8%)
160+
TOON █████████████░░░░░░░ 224,940 tokens (+56.6%)
161+
YAML █████████████░░░░░░░ 224,938 tokens (+56.6%)
162+
JSON format ████████████████████ 284,132 tokens (+97.8%)
163+
XML ████████████████████ 335,239 tokens (+133.4%)
164164
165165
claude 3.5 (anthropic):
166166
167-
ZON █████████░░░░░░░░░░░ 145,652 tokens 👑
168-
CSV ██████████░░░░░░░░░░ 161,701 tokens (+11.0%)
169-
JSON (cmp) ███████████░░░░░░░░░ 185,136 tokens (+21.3%)
170-
TOON ████████████░░░░░░░░ 196,893 tokens (+35.2%)
171-
YAML ████████████░░░░░░░░ 196,892 tokens (+35.2%)
172-
JSON format ████████████████████ 274,149 tokens (+88.2%)
173-
XML ████████████████████ 327,274 tokens (+124.7%)
167+
ZON █████████░░░░░░░░░░░ 145,652 tokens 👑
168+
CSV ██████████░░░░░░░░░░ 161,701 tokens (+11.0%)
169+
JSON (cmp) ███████████░░░░░░░░░ 185,136 tokens (+21.3%)
170+
TOON ████████████░░░░░░░░ 196,893 tokens (+35.2%)
171+
YAML ████████████░░░░░░░░ 196,892 tokens (+35.2%)
172+
JSON format ████████████████████ 274,149 tokens (+88.2%)
173+
XML ████████████████████ 327,274 tokens (+124.7%)
174174
175175
llama 3 (meta):
176176
177-
ZON ██████████░░░░░░░░░░ 230,838 tokens 👑
178-
CSV ███████████░░░░░░░░░ 254,181 tokens (+10.1%)
179-
JSON (cmp) ████████████░░░░░░░░ 276,405 tokens (+16.5%)
180-
TOON █████████████░░░░░░░ 314,824 tokens (+36.4%)
181-
YAML █████████████░░░░░░░ 314,820 tokens (+36.4%)
182-
JSON format ████████████████████ 407,488 tokens (+76.5%)
183-
XML ████████████████████ 480,125 tokens (+108.0%)
177+
ZON ██████████░░░░░░░░░░ 230,838 tokens 👑
178+
CSV ███████████░░░░░░░░░ 254,181 tokens (+10.1%)
179+
JSON (cmp) ████████████░░░░░░░░ 276,405 tokens (+16.5%)
180+
TOON █████████████░░░░░░░ 314,824 tokens (+36.4%)
181+
YAML █████████████░░░░░░░ 314,820 tokens (+36.4%)
182+
JSON format ████████████████████ 407,488 tokens (+76.5%)
183+
XML ████████████████████ 480,125 tokens (+108.0%)
184184
```
185185

186186
#### Overall Summary:
@@ -286,9 +286,9 @@ hikes[3]{id,name,distanceKm,elevationGain,companion,wasSunny}:
286286
287287
</details>
288288
289+
289290
ZON conveys the same information with **even fewer tokens** than TOON – using compact table format with explicit headers:
290291
291-
```
292292
```
293293
context{location:Boulder,season:spring_2025,task:Our favorite hikes together}
294294
friends[ana,luis,sam]
@@ -321,7 +321,7 @@ ZON is the only library that gives you **both in one package**.
321321
## Key Features
322322

323323
- 🎯 **100% LLM Accuracy**: Achieves perfect retrieval (309/309 questions) with self-explanatory structure – no hints needed
324-
### 3. Smart Flattening (Dot Notation)
324+
### Smart Flattening (Dot Notation)
325325
ZON automatically flattens top-level nested objects to reduce indentation.
326326
**JSON:**
327327
```json
@@ -338,7 +338,7 @@ ZON automatically flattens top-level nested objects to reduce indentation.
338338
config{database{host:localhost}}
339339
```
340340

341-
### 4. Colon-less Structure
341+
### Colon-less Structure
342342
For nested objects and arrays, ZON omits the redundant colon, creating a cleaner, block-like structure.
343343
**JSON:**
344344
```json
@@ -427,8 +427,6 @@ ZON is **immune to code injection attacks** that plague other formats:
427427

428428
### Data Type Preservation
429429

430-
### Data Type Preservation
431-
432430
**Strong type guarantees:**
433431
- ✅ **Integers**: `42` stays integer
434432
- ✅ **Floats**: `3.14` preserves decimal (`.0` added for whole floats)

0 commit comments

Comments
 (0)