Skip to content

Commit cd6cfc4

Browse files
NSHkrNSHkr
authored andcommitted
update readme
1 parent 4c7caf3 commit cd6cfc4

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
A comprehensive, production-ready JSON repair library for Elixir that intelligently fixes malformed JSON strings from any source—LLMs, legacy systems, data pipelines, streaming APIs, and human input.
1111

12-
**JsonRemedy** uses a sophisticated 5-layer repair pipeline where each layer employs the most appropriate technique: regex for content cleaning, state machines for structural repairs, character-by-character parsing for syntax normalization, and battle-tested parsers for validation. The result is a robust system that handles virtually any JSON malformation while preserving valid content.
12+
**JsonRemedy** uses a sophisticated 5-layer repair pipeline where each layer employs the most appropriate technique: content cleaning, state machines for structural repairs, character-by-character parsing for syntax normalization, and battle-tested parsers for validation. The result is a robust system that handles virtually any JSON malformation while preserving valid content.
1313

1414
## The Problem
1515

@@ -432,7 +432,7 @@ JsonRemedy's strength comes from its pragmatic, layered approach where each laye
432432
defmodule JsonRemedy.LayeredRepair do
433433
def repair(input) do
434434
input
435-
|> Layer1.content_cleaning() # Regex: Remove wrappers, comments, normalize encoding
435+
|> Layer1.content_cleaning() # Cleaning: Remove wrappers, comments, normalize encoding
436436
|> Layer2.structural_repair() # State machine: Fix delimiters, nesting, structure
437437
|> Layer3.syntax_normalization() # Char parsing: Fix quotes, booleans, commas
438438
|> Layer4.validation_attempt() # Jason.decode: Fast path for clean JSON
@@ -442,9 +442,9 @@ end
442442
```
443443

444444
### 🧹 **Layer 1: Content Cleaning**
445-
**Technique**: Regex and string operations (perfect for this job)
445+
**Technique**: String operations
446446
- Removes code fences, comments, wrapper text
447-
- Normalizes encoding and whitespace
447+
- Normalizes encoding and whitespace
448448
- Extracts JSON from prose and HTML
449449
- Handles streaming artifacts
450450

0 commit comments

Comments
 (0)