Skip to content

Commit 208c8a7

Browse files
committed
cleanups README.md
1 parent 8596723 commit 208c8a7

1 file changed

Lines changed: 4 additions & 6 deletions

File tree

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ bytecode.
8383

8484
## Design principles
8585

86-
- Zero-copy as much as possible
86+
- Zero-copy everywhere
8787
- No JNI
88-
- No Unsafe -- don't remove safety to gain few %
88+
- No Unsafe -- [FFM vs Unsafe](https://inside.java/2025/06/12/ffm-vs-unsafe/) — Maurizio Cimadamore's deep-dive on why FFM (`MemorySegment`/`Arena`) supersedes `sun.misc.Unsafe`: safety, performance, and the JVM's path forward
8989
- Align with vortex-rust and Vortex-go semantics
9090
- Make the JIT happy (constant layouts, predictable strides, no virtual dispatch in hot loops)
9191
- Prepare for the Vector API / Valhalla
@@ -96,7 +96,7 @@ bytecode.
9696
|-------------------------------------------------------------|----------|---------------------------------------------------------------------|
9797
| [spiraldb/vortex](https://github.com/spiraldb/vortex) | Rust | Reference implementation + JNI bindings |
9898
| [spiraldb/vortex-go](https://github.com/spiraldb/vortex-go) | Go | Pure-language port; primary inspiration for this project's approach |
99-
- [FFM vs Unsafe](https://inside.java/2025/06/12/ffm-vs-unsafe/) — Maurizio Cimadamore's deep-dive on why FFM (`MemorySegment`/`Arena`) supersedes `sun.misc.Unsafe`: safety, performance, and the JVM's path forward
99+
100100

101101
## Serialization formats
102102

@@ -128,7 +128,7 @@ Add the library to your build (example, Maven):
128128
</dependency>
129129
```
130130

131-
Open and read a Vortex file (illustrative API):
131+
Open and read a Vortex file:
132132

133133
```java
134134
import io.github.dfa1.vortex.reader.VortexFile;
@@ -158,8 +158,6 @@ requiring it means no preview flags, no upgrade risk, and a supported LTS for us
158158

159159
```bash
160160
./mvnw verify
161-
# Run tests
162-
./mvnw test
163161
```
164162

165163
## License

0 commit comments

Comments
 (0)