weaselab/weaseljson
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Andrew Noyes
2025-08-25 15:57:07 -04:00
parent e8d2855b36
commit 611bccfb9b
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -23,15 +23,15 @@ WeaselJSON is a high-performance, streaming JSON parser that uses callbacks inst
```mermaid ```mermaid
flowchart TD flowchart TD
A[Need to parse JSON?] --> B{Do you have memory constraints<br/>or truly streaming data?} A[Need to parse JSON?] --> B{Do you have memory constraints<br/>or do you want to parse partial data?}
B -->|No| C{Is performance critical<br/>and data fits in memory?} B -->|No| C{Is performance critical<br/>and data fits in memory?}
B -->|Yes| D{Can you control<br/>how the JSON is laid out?} B -->|Yes| D{Can you control<br/>how the JSON is laid out?}
C -->|No| E[SimdJSON DOM API<br/>Fast and easy to use<br/>Wait why are you using C++?] C -->|No| E[SimdJSON DOM API<br/>Fast and easy to use]
C -->|Yes| F{Are you OK with potential<br/>performance traps?} C -->|Yes| F{Are you OK with potential<br/>performance traps?}
F -->|Yes| G[SimdJSON On-Demand<br/>Very fast<br/>Nice API<br/>Easy to use wrong] F -->|Yes| G[SimdJSON On-Demand<br/>Very fast<br/>Nice API<br/>Forward-only traversal]
F -->|No| H[Consider weaseljson<br/>if you can deal with callbacks] F -->|No| H[Consider weaseljson<br/>if you can deal with callbacks]
D -->|No| I{Can you preprocess data<br/>or make multiple requests?} D -->|No| I{Can you preprocess data<br/>or make multiple requests?}
@@ -50,8 +50,9 @@ flowchart TD
### Use **SimdJSON On-Demand** when: ### Use **SimdJSON On-Demand** when:
- Performance is critical and your data fits in memory - Performance is critical and your data fits in memory
- You understand that some access patterns can accidentally become very slow - You can work with forward-only traversal (no random access or backtracking)
- You need maximum speed but still want a usable API - You need maximum speed but still want a usable API
- Your JSON structure is consistent and you control both generation and parsing
### Use **WeaselJSON** when: ### Use **WeaselJSON** when:
- You absolutely cannot load the whole JSON into memory - You absolutely cannot load the whole JSON into memory