Skip to content

Commit 0a8c413

Browse files
authored
Update README.md - Added Architecture Overview
Added overview diagram from #40 (comment)
1 parent 4ffa837 commit 0a8c413

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,41 @@ A robust JSON5 parser and serializer for Kotlin that extends JSON with helpful f
99
1010
<a href="https://github.com/hossain-khan/json5-kotlin/tree/main/benchmark"><img src="project-assets/benchmark-charts/json5-by-library-type.png" width="600" alt="Benchmark with different JSON libraries"></a>
1111

12+
13+
### Architecture Overview
14+
```mermaid
15+
graph TD
16+
subgraph lib [lib: JSON5 Core Library]
17+
JSON5
18+
JSON5Parser
19+
JSON5Lexer
20+
JSON5Serializer
21+
JSON5Value
22+
JSON5Exception
23+
end
24+
25+
subgraph app [app: Application]
26+
AppCode
27+
end
28+
29+
subgraph benchmark [benchmark: Performance Benchmarks]
30+
BenchmarkCode
31+
end
32+
33+
AppCode -->|uses| JSON5
34+
BenchmarkCode -->|uses| JSON5
35+
36+
JSON5 -->|parsing| JSON5Parser
37+
JSON5Parser -->|tokenizes| JSON5Lexer
38+
JSON5 -->|serializing| JSON5Serializer
39+
JSON5Parser -->|returns| JSON5Value
40+
JSON5Serializer -->|outputs| JSON5Value
41+
JSON5Parser -->|errors| JSON5Exception
42+
JSON5Lexer -->|errors| JSON5Exception
43+
JSON5Serializer -->|errors| JSON5Exception
44+
```
45+
46+
1247
## Features
1348

1449
[JSON5](https://json5.org/) extends JSON with the following features:

0 commit comments

Comments
 (0)