Skip to content

Commit 21acbe5

Browse files
committed
Add README.md
1 parent 35e456c commit 21acbe5

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# zstd-java
2+
3+
Java bindings for the Zstandard compression library. Its meant to replace the use of JNI with FFM.
4+
5+
### Usage
6+
Adding to Gradle (kts):
7+
```kotlin
8+
repositories {
9+
mavenCentral()
10+
}
11+
12+
dependencies {
13+
implementation("dev.hallock.zstd:zstd:0.1.0")
14+
}
15+
```
16+
17+
### Java
18+
Requires Java 25 and will target LTS releases.
19+
20+
#### Resources
21+
- [Zstandard](https://facebook.github.io/zstd/doc/api_manual_latest.html)
22+
- [FFM](https://docs.oracle.com/en/java/javase/25/core/foreign-function-and-memory-api.html)
23+
- [Jextract](https://github.com/openjdk/jextract/blob/master/doc/GUIDE.md)
24+
25+
<details>
26+
<summary>AI Disclosure</summary>
27+
AI was used to generate the Demo example, and most of the tests. My philosophy is that AI generated tests are slightly better coverage than no coverage.
28+
This may change in the future and is the only place(s) that is acceptable usage.
29+
</details>
30+
31+
32+

0 commit comments

Comments
 (0)