Merge pull request #33 from talex5/release

Prepare release

Author: talex5

CHANGES.md

@@ -1,3 +1,3 @@
-## dev
+## v0.1
 
-- no public release
+- Initial release.

README.md

@@ -1,7 +1,20 @@
 # ocaml-uring -- bindings to Linux io_uring
 
-These are OCaml bindings for the Linux io_uring stack.
-They are intended to eventually be used with the multicore OCaml stack,
-but may also be useful for sequential code too.
+These are OCaml bindings for the Linux [io_uring][] stack
+(an alternative to using syscalls such as `select` or `epoll`).
 
-- Status: work in progress, unreleased.
+The [Eio][] library provides a higher-level effects-based API
+that uses this library to implement its Linux backend,
+but ocaml-uring may be useful with single-core non-effects versions of OCaml too.
+
+To use the library directly:
+
+1. Call `Uring.create` to initialise a ring.
+2. Add IO requests to the ring using functions such as `Uring.readv`.
+3. Call `Uring.submit` to notify the kernel of the new requests.
+4. Call `Uring.wait` to wait until an operation is complete.
+
+The `tests` directory contains some examples.
+
+[io_uring]: https://github.com/axboe/liburing
+[Eio]: https://github.com/ocaml-multicore/eio

dune-project

@@ -4,12 +4,12 @@
 (formatting disabled)
 (source (github ocaml-multicore/ocaml-uring))
 (license ISC)
-(authors "Anil Madhavapeddy" "Sadiq Jaffer")
+(authors "Anil Madhavapeddy" "Sadiq Jaffer" "Thomas Leonard")
 (maintainers "[email protected]")
 (package
  (name uring)
  (synopsis "OCaml bindings for Linux io_uring")
- (description "Bindings to the Linux io_uring kernel IO interfaces.")
+ (description "Bindings to the Linux io_uring kernel IO interfaces. See https://github.com/ocaml-multicore/eio for a higher-level API using this.")
  (depends
   (cstruct (>= 6.0.0))
   (ocaml (>= 4.12.0))

uring.opam

@@ -1,9 +1,10 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
 synopsis: "OCaml bindings for Linux io_uring"
-description: "Bindings to the Linux io_uring kernel IO interfaces."
+description:
+  "Bindings to the Linux io_uring kernel IO interfaces. See https://github.com/ocaml-multicore/eio for a higher-level API using this."
 maintainer: ["[email protected]"]
-authors: ["Anil Madhavapeddy" "Sadiq Jaffer"]
+authors: ["Anil Madhavapeddy" "Sadiq Jaffer" "Thomas Leonard"]
 license: "ISC"
 homepage: "https://github.com/ocaml-multicore/ocaml-uring"
 bug-reports: "https://github.com/ocaml-multicore/ocaml-uring/issues"