Skip to content

Commit ef537a1

Browse files
committed
manual review README.md
1 parent 9d38346 commit ef537a1

1 file changed

Lines changed: 12 additions & 9 deletions

File tree

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,23 @@ are readable by all others — no vendor lock-in, no format translation at the b
2424
| Project | Language | Notes |
2525
|-------------------------------------------------------------|----------|---------------------------------------------------------------------|
2626
| [spiraldb/vortex](https://github.com/spiraldb/vortex) | Rust | Reference implementation + JNI bindings |
27-
| [spiraldb/vortex-go](https://github.com/spiraldb/vortex-go) | Go | Pure-language port
27+
| [spiraldb/vortex-go](https://github.com/spiraldb/vortex-go) | Go | Pure-language port
2828

2929
The official Vortex ecosystem provides JVM bindings via JNI (bundled native `.so`/`.dylib`).
3030
JNI bindings are fast but add deployment friction: platform-specific artifacts, native build
31-
toolchains, and crash-domain coupling between the JVM and native code.
31+
toolchains, and crash-domain coupling between the JVM and native code. The JAR vortex-jni 0.72 is
32+
**258MB**..
3233

3334
This library takes a different approach — 100% Java, no JNI, no `sun.misc.Unsafe`.
34-
It uses the Java FFM API (`MemorySegment` / `Arena`, Java 25+) for zero-copy memory-mapped reads,
35+
It uses the Java FFM API (`MemorySegment` / `Arena`, Java 25+) for zero-copy memory-mapped reads,
3536
making it easier to:
3637

3738
- embed in any JVM project without native-library management
3839
- build and test on any platform with a standard JDK
3940
- debug and profile with standard JVM tooling
4041

42+
The JARs in this library are tiny, less than **1MB** in total.
43+
4144
## Who is this for?
4245

4346
- JVM analytics engines
@@ -279,7 +282,7 @@ JMH throughput (ops/s = full-file scans per second). Higher is better.
279282
280283
### Why fewer layers = faster
281284
282-
This is my hypothesis:
285+
This is my hypothesis:
283286
```
284287
vortex-jni vortex-java
285288
────────────────────────────── ──────────────────────────
@@ -325,12 +328,12 @@ bytecode.
325328
326329
## Contributing
327330
328-
Forks and contributions are welcome! Please feel free to fork the repository and open a pull request.
329-
When submitting a PR, include tests and update documentation where applicable
331+
Forks and contributions are welcome! Please feel free to fork the repository and open a pull request.
332+
When submitting a PR, include tests and update documentation where applicable
330333
(follow guidelines in CLAUDE.md).
331334
332-
### AI-assisted development
335+
### AI-assisted development
333336
334337
This project uses [Claude Code](https://claude.ai/code) heavily for implementation
335-
work — generating mapping, test generation and documentation.
336-
**Architecture, API design, and all decisions are human-driven**.
338+
work — generating mapping, test generation and documentation.
339+
**Architecture, API design, and all decisions are human-driven**.

0 commit comments

Comments
 (0)