Skip to content

Commit

Permalink
Tweak README intro and sample output
Browse files Browse the repository at this point in the history
  • Loading branch information
lopcode committed Aug 12, 2024
1 parent f3282c1 commit 80f9be9
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# vips-ffm

A thin wrapper to let Java/JVM projects use [libvips](https://github.com/libvips/libvips), via the
"Foreign Function & Memory API" ([JEP 454](https://openjdk.org/jeps/454)) released in JDK 22.
[libvips](https://github.com/libvips/libvips) bindings for JVM projects, using the "Foreign Function & Memory API"
([JEP 454](https://openjdk.org/jeps/454)) released in JDK 22. The combination of libvips and FFM makes for performant, safe, and ergonomic image
manipulation in JVM systems, supporting a vast range of image formats, including HEIC, JXL, WebP, PNG, JPEG, and more.
Pronounced "vips (like zips) eff-eff-emm".

Incubating in [Photo Fox](https://github.com/lopcode/photo-fox). Pronounced "vips (like hips) eff-eff-emm".
Incubating in [Photo Fox](https://github.com/lopcode/photo-fox).

## Project goals

Expand Down Expand Up @@ -31,5 +33,9 @@ This project includes a proof of concept that only runs on macOS. To run it:
[main] INFO vipsffm.VipsFfm - running sample "GetVersionSample"...
[main] INFO vipsffm.GetVersionSample - libvips version: "8.15.2"
[main] INFO vipsffm.VipsFfm - validation succeeded ✅
[main] INFO vipsffm.VipsFfm - running sample "CreateThumbnailSample"...
[main] INFO vipsffm.GetVersionSample - source image size: 2490 x 3084
[main] INFO vipsffm.GetVersionSample - output image size: 323 x 400
[main] INFO vipsffm.VipsFfm - validation succeeded ✅
[main] INFO vipsffm.VipsFfm - all samples ran successfully 🎉
```

0 comments on commit 80f9be9

Please sign in to comment.