brevit 0.1.3 → 0.1.5

package/README.md

@@ -1,24 +1,24 @@
-# Brevit.js
+# brevit
 
 A high-performance JavaScript library for semantically compressing and optimizing data before sending it to a Large Language Model (LLM). Dramatically reduce token costs while maintaining data integrity and readability.
 
 ## Table of Contents
 
-- [Why Brevit.js?](#why-brevitjs)
+- [Why brevit?](#why-brevit)
 - [Key Features](#key-features)
-- [When Not to Use Brevit.js](#when-not-to-use-brevitjs)
+- [When Not to Use brevit](#when-not-to-use-brevit)
 - [Benchmarks](#benchmarks)
 - [Installation & Quick Start](#installation--quick-start)
 - [Playgrounds](#playgrounds)
 - [CLI](#cli)
 - [Format Overview](#format-overview)
 - [API](#api)
-- [Using Brevit.js in LLM Prompts](#using-brevitjs-in-llm-prompts)
+- [Using brevit in LLM Prompts](#using-brevit-in-llm-prompts)
 - [Syntax Cheatsheet](#syntax-cheatsheet)
 - [Other Implementations](#other-implementations)
 - [Full Specification](#full-specification)
 
-## Why Brevit.js?
+## Why brevit?
 
 ### JavaScript-Specific Advantages
 
@@ -53,7 +53,7 @@ const explicit = await brevit.optimize(complexOrder);
 
 ### Automatic Strategy Selection
 
-Brevit.js now includes the `.brevity()` method that automatically analyzes your data and selects the optimal optimization strategy:
+brevit now includes the `.brevity()` method that automatically analyzes your data and selects the optimal optimization strategy:
 
 ```javascript
 const data = {
@@ -110,7 +110,7 @@ pnpm add brevit
 
 ### TypeScript Support
 
-Brevit.js includes full TypeScript definitions. Simply import and use with full type safety:
+brevit includes full TypeScript definitions. Simply import and use with full type safety:
 
 ```typescript
 import {
@@ -130,7 +130,7 @@ const client = new BrevitClient(new BrevitConfig(config));
 
 ## Complete Usage Examples
 
-Brevit.js supports three main data types: **JSON objects/strings**, **text files/strings**, and **images**. Here's how to use each:
+brevit supports three main data types: **JSON objects/strings**, **text files/strings**, and **images**. Here's how to use each:
 
 ### 1. JSON Optimization Examples
 
@@ -219,20 +219,6 @@ const optimized = await brevit.brevity(jsonString);
 // @o.status:SHIPPED
 ```
 
-#### Example 1.2a: Abbreviations Disabled
-
-```javascript
-const brevitNoAbbr = new BrevitClient(new BrevitConfig({ 
-  jsonMode: JsonOptimizationMode.Flatten,
-  enableAbbreviations: false  // Disable abbreviations
-}));
-
-const jsonString = '{"order": {"id": "o-456", "status": "SHIPPED"}}';
-const optimized = await brevitNoAbbr.brevity(jsonString);
-// Output (without abbreviations):
-// order.id:o-456
-// order.status:SHIPPED
-```
 
 #### Example 1.3: Complex Nested JSON with Arrays
 
@@ -276,51 +262,6 @@ const optimized = await brevit.brevity(complexData);
 // luis,9.2,540,2,Ridge Overlook,false
 ```
 
-#### Example 1.3a: Complex Data with Abbreviations Disabled
-
-```javascript
-const brevitNoAbbr = new BrevitClient(new BrevitConfig({ 
-  jsonMode: JsonOptimizationMode.Flatten,
-  enableAbbreviations: false  // Disable abbreviations
-}));
-
-const complexData = {
-  context: {
-    task: "Our favorite hikes together",
-    location: "Boulder",
-    season: "spring_2025"
-  },
-  friends: ["ana", "luis", "sam"],
-  hikes: [
-    {
-      id: 1,
-      name: "Blue Lake Trail",
-      distanceKm: 7.5,
-      elevationGain: 320,
-      companion: "ana",
-      wasSunny: true
-    },
-    {
-      id: 2,
-      name: "Ridge Overlook",
-      distanceKm: 9.2,
-      elevationGain: 540,
-      companion: "luis",
-      wasSunny: false
-    }
-  ]
-};
-
-const optimized = await brevitNoAbbr.brevity(complexData);
-// Output (without abbreviations):
-// context.task:Our favorite hikes together
-// context.location:Boulder
-// context.season:spring_2025
-// friends[3]:ana,luis,sam
-// hikes[2]{companion,distanceKm,elevationGain,id,name,wasSunny}:
-// ana,7.5,320,1,Blue Lake Trail,true
-// luis,9.2,540,2,Ridge Overlook,false
-```
 
 #### Example 1.4: Different JSON Optimization Modes
 
@@ -643,7 +584,7 @@ processOrder(order).then(console.log);
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Brevit.js Example</title>
+  <title>brevit Example</title>
 </head>
 <body>
   <script type="module">
@@ -880,14 +821,16 @@ const user = {
 };
 
 const optimized = await brevit.optimize(user);
-// Output:
-// id: u-123
-// name: Javian
-// isActive: true
-// contact.email: support@javianpicardo.com
-// contact.phone: null
-// orders[0].orderId: o-456
-// orders[0].status: SHIPPED
+// Output (with abbreviations enabled by default):
+// @c=contact
+// @o=orders
+// id:u-123
+// name:Javian
+// isActive:true
+// @c.email:support@javianpicardo.com
+// @c.phone:null
+// @o[0].orderId:o-456
+// @o[0].status:SHIPPED
 ```
 
 ### Example 2: Optimize JSON String
@@ -925,7 +868,7 @@ const optimized = await brevit.optimize(imageData);
 // Will trigger image optimization
 ```
 
-## When Not to Use Brevit.js
+## When Not to Use brevit
 
 Consider alternatives when:
 
@@ -1199,7 +1142,7 @@ class BrevitConfig {
 - `Ocr` - Extract text via OCR
 - `Metadata` - Extract metadata only
 
-## Using Brevit.js in LLM Prompts
+## Using brevit in LLM Prompts
 
 ### Best Practices
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "brevit",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "A high-performance JavaScript library for semantically compressing and optimizing data before sending it to a Large Language Model (LLM).",
   "main": "src/brevit.js",
   "types": "src/brevit.d.ts",