README: Explain about FFI support
Languages and applications that can't use 'static inline' functions in
liburing.h should use the FFI variants.
Link:
@@ -71,6 +71,30 @@ Building liburing
See './configure --help' for more information about build config options.
+FFI support
+-----------
+
+By default, the build results in 4 lib files:
+
+ 2 shared libs:
+
+ liburing.so
+ liburing-ffi.so
+
+ 2 static libs:
+
+ liburing.a
+ liburing-ffi.a
+
+Languages and applications that can't use 'static inline' functions in
+liburing.h should use the FFI variants.
+
+liburing's main public interface lives in liburing.h as 'static inline'
+functions. Users wishing to consume liburing purely as a binary dependency
+should link against liburing-ffi. It contains definitions for every 'static
+inline' function.
+
+
License
-------
