Skip to content

Commit bcc5e4d

Browse files
committed
docs: actualizar tagline y diagrama de arquitectura en README
Reflejar que los wrappers conectan vía FFI o subprocess, y reemplazar el diagrama ASCII por Mermaid para mejor legibilidad en GitHub.
1 parent 906b0db commit bcc5e4d

1 file changed

Lines changed: 11 additions & 20 deletions

File tree

README.md

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<a href="https://github.com/Kevinsillo/anvildb/actions/workflows/tests.yml"><img src="https://github.com/Kevinsillo/anvildb/actions/workflows/tests.yml/badge.svg" alt="Tests"></a>
1010
</p>
1111

12-
<p align="center"><strong>Embedded JSON document database powered by a Rust core, with language wrappers via FFI.</strong></p>
12+
<p align="center"><strong>Embedded JSON document database powered by a Rust core, with language wrappers via FFI or subprocess.</strong></p>
1313

1414
<p align="center">Zero external dependencies. No MySQL, PostgreSQL, SQLite, or PDO required. Just your filesystem and raw speed.</p>
1515

@@ -50,26 +50,17 @@ Want to create a wrapper for another language? See the [Wrapper Development Guid
5050

5151
## Architecture
5252

53+
```mermaid
54+
graph TD
55+
App[Application] --> Wrapper[Language Wrapper]
56+
57+
Wrapper -->|FFI · direct| Core[Rust Core Engine]
58+
Wrapper -->|Subprocess · stdin/stdout| Server[anvildb-server] --> Core
59+
60+
Core --> FS[("Filesystem (.anvil)")]
5361
```
54-
Application
55-
|
56-
v
57-
Language Wrapper (PHP, Python, etc.)
58-
| |
59-
| FFI (direct, fastest) | Process (no extensions needed)
60-
| JSON strings + handle | JSON lines over stdin/stdout
61-
v v
62-
Rust Core Engine anvildb-server
63-
| - Write Buffer (dirty tracking + batched flush)
64-
| - LRU Cache (auto-invalidated)
65-
| - In-memory Indexes (Hash / Unique / Range)
66-
| - Query Engine (filter, join, sort, paginate)
67-
| - Schema Validation
68-
| - Codec (deflate compression + optional AES-256-GCM)
69-
| - Atomic Storage (temp file + rename)
70-
v
71-
Filesystem (.anvil compressed + metadata.json)
72-
```
62+
63+
**Core internals:** Write Buffer · LRU Cache · In-memory Indexes (Hash, Unique, Range) · Query Engine (filter, join, sort, paginate) · Schema Validation · Codec (deflate + AES-256-GCM) · Atomic Storage
7364

7465
## Performance
7566

0 commit comments

Comments
 (0)