json-toon-parser 1.1.2 → 1.1.3

package/README.md

@@ -1,6 +1,6 @@
 # json-toon-parser
 
-**Version:** 1.1.2  •  **License:** MIT  •  **Format:** TOON
+**Version:** 1.1.3  •  **License:** MIT  •  **Format:** TOON
 
 High-efficiency conversion and analysis toolkit: JSON → TOON with CLI, API, and Web UI server for real‑time token savings. Ideal for reducing LLM prompt payload size and optimizing costs.
 
@@ -67,38 +67,104 @@ const toonString = jsonToToon({ hello: "world" });
 - 🧪 GPT-style token counting via `gpt-3-encoder`
 
 ## API (Summary)
+# json-toon-parser
+
+[![npm version](https://img.shields.io/npm/v/json-toon-parser.svg)](https://www.npmjs.com/package/json-toon-parser)
+[![npm downloads](https://img.shields.io/npm/dm/json-toon-parser.svg)](https://www.npmjs.com/package/json-toon-parser)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+================================================================================
+
+🚀 json-toon-parser — JSON → TOON converter, token optimizer, and developer toolkit
+
+Convert verbose JSON into compact TOON, reduce LLM token usage, and measure savings.
+
+Perfect for teams and engineers integrating large structured payloads into ChatGPT/OpenAI/Claude prompts or storage pipelines.
+
+Official NPM package: https://www.npmjs.com/package/json-toon-parser
+
+Documentation: `docs/API.md`
+
+================================================================================
+
+## Quick Install
+
+Global (CLI + Web UI):
+
+```bash
+npm install -g json-toon-parser
+```
+
+Programmatic (project):
+
+```bash
+npm install json-toon-parser
+```
+
+Verify:
+
+```bash
+json-toon --version
+json-toon serve
+```
+
+================================================================================
 
-Full reference: see `docs/API.md`.
+## Why TOON? — The Value Proposition
 
-### `compare(jsonData, options?)`
-Compare JSON data with TOON format and calculate token efficiency.
+TOON is a compact, human-friendly serialization optimized for token-efficient LLM prompts. It removes syntactic noise (quotes, braces, commas), reduces repeated keys, and uses concise array and nesting notation — which directly translates to lower API costs and faster transmission.
 
-**Parameters:**
-- `jsonData`: Any JSON-serializable data
-- `options`: Optional configuration
-  - `outputDir`: Output directory (default: "output")
-  - `saveToFile`: Save TOON file (default: false)
-  - `prettyJson`: Pretty print JSON (default: true)
-  - `fileName`: Custom filename
+- Reduce per-request token counts by 40–70% (depends on structure)
+- Keep payloads human-readable and reversible via the TOON library
+- Ideal for prompts, telemetry, logs, and mobile/edge transfers
 
-**Returns:** `ComparisonResult` with token counts and savings
+================================================================================
+
+## Features
 
-### `compareFile(filePath, options?)`
-Compare JSON file with TOON format.
+- CLI: `serve`, `compare`, `convert`, `update`
+- Web UI: interactive editor, samples, copy & download
+- Programmatic API (TypeScript types included)
+- Token analysis using `gpt-3-encoder` for GPT-style counts
+- Save TOON output with timestamped filenames
 
-### `convertFile(inputPath, outputPath?)`
-Convert JSON file to TOON format and save.
+================================================================================
 
-### `jsonToToon(jsonData)`
-Convert JSON data to TOON format string.
+## Usage Examples
 
-### `updateJsonFile(filePath, outputPath?)`
-Update JSON file and generate TOON comparison.
+CLI
+
+```bash
+# Start web UI
+json-toon serve
 
-### `formatResult(result)`
-Format comparison result for display.
+# Compare & save TOON
+json-toon compare data/input.json --save
+
+# Convert file
+json-toon convert data/input.json output.toon
+
+# Update JSON and produce comparison
+json-toon update data/input.json
+```
+
+Programmatic
+
+```ts
+import { compare, jsonToToon } from 'json-toon-parser';
+
+const data = { users: [{ id: 1, name: 'Alice' }] };
+const toon = jsonToToon(data);
+const result = compare(data, { saveToFile: false });
+console.log(result.toonOutput);
+```
+
+================================================================================
+
+## Example Comparison
+
+Use this example to demonstrate typical savings — include it in docs, blog posts, or README highlights:
 
-## Example CLI Output
 ```
 ============================================================
 COMPARISON RESULTS
@@ -111,24 +177,39 @@ Output File:     output/data_DateTime.toon
 ============================================================
 ```
 
-## Use Cases
+================================================================================
+
+## When TOON Is Most Effective
+
+- Nested JSON with many structural characters
+- Large arrays of similar objects
+- Repetitive keys repeated across objects
+- Prompts that include large contexts for LLMs
 
-- 🔍 Token Analysis – Quantify savings before sending payloads
-- 💾 Payload Compression – Minimize size for storage or transfer
-- 📊 Batch Conversion – Automate directory/file transformations
-- 🛠️ CI Integration – Enforce efficiency gates in pipelines
-- 📈 LLM Cost Reduction – Lower prompt token usage dramatically
+================================================================================
 
-## Requirements
+## Performance Notes
 
-- Node.js ≥ 18.0.0
+Token counting is approximated with `gpt-3-encoder`. Results may vary slightly by tokenizers used by different LLM providers, but the relative savings are consistent.
 
-## Contributing & Support
+================================================================================
 
-Issues / feature requests: https://github.com/bhushan44/json-toon-parser/issues
-API Reference: `docs/API.md`
-Quick Start Guide: `QUICKSTART.md`
+## Links & Resources
+
+- NPM: https://www.npmjs.com/package/json-toon-parser
+- TOON format: https://github.com/toon-format/toon
+- API docs: `docs/API.md`
+
+================================================================================
+
+## Contributing
+
+See `CONTRIBUTING.md` to get started. We welcome PRs, issues, and ideas.
+
+================================================================================
 
 ## License
 
 MIT © Bhushan Chaudhari
+
+================================================================================

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-toon-parser",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Compare and convert JSON to TOON format with token efficiency analysis – includes CLI, API, and Web UI server.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -35,25 +35,86 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/bhushan44/json-toon-parser.git"
-  },
-  "homepage": "https://github.com/bhushan44/json-toon-parser#readme",
-  "bugs": {
-    "url": "https://github.com/bhushan44/json-toon-parser/issues"
+    "url": "git+https://github.com/bhushan020/json-toon-parser.git"
   },
+  "homepage": "https://github.com/bhushan020/json-toon-parser#readme",
   "keywords": [
     "json",
-    "toon",
     "parser",
     "converter",
     "tokenization",
+    "toon",
+    "toon-format",
+    "toon-parser",
+    "toon-tokenizer",
+    "json-to-toon",
+    "json-toon-parser",
+    "JSON-to-TOON",
     "gpt",
-    "compression",
-    "format",
-    "efficiency",
+    "llm",
+    "prompt-optimizer",
     "token-optimization",
+    "token-efficiency",
+    "compression",
+    "data-compression",
+    "text-compression",
+    "minifier",
+    "custom-format",
+    "format-converter",
     "webui",
-    "cli"
+    "cli",
+    "developer-tools",
+    "nodejs",
+    "javascript",
+    "npm-package",
+    "open-source",
+    "json-optimizer",
+    "json-minifier",
+    "json-transform",
+    "json-formatter",
+    "json-analysis",
+    "json-compression",
+    "structured-data",
+    "structured-format",
+    "compact-format",
+    "compact-data",
+    "lightweight-serialization",
+    "serialization",
+    "deserialization",
+    "data-encoding",
+    "data-decoding",
+    "token-counter",
+    "token-metrics",
+    "token-saver",
+    "llm-tools",
+    "chatgpt-tools",
+    "openai-tools",
+    "ai-developer-tools",
+    "prompt-tools",
+    "prompt-engineering",
+    "payload-optimizer",
+    "text-optimizer",
+    "data-optimizer",
+    "json-cli",
+    "json-webui",
+    "llm-friendly",
+    "prompt-friendly",
+    "structured-compression",
+    "encoding-tools",
+    "decoder",
+    "encoder",
+    "tree-shakeable",
+    "typescript",
+    "ts-library",
+    "backend-tools",
+    "automation-tools",
+    "productivity-tools",
+    "developer-productivity",
+    "dev-cli",
+    "api-tools",
+    "file-conversion",
+    "file-transform",
+    "data-utilities"
   ],
   "author": "Bhushan Chaudhari <bhushanschaudhari4@gmail.com>",
   "license": "MIT",