From 829fd6b2d494ebff82f0c9aa82e95f19991f34e1 Mon Sep 17 00:00:00 2001 From: Francesco Cozzuto Date: Sun, 7 Apr 2024 22:18:54 +0200 Subject: [PATCH] Update README --- README.txt | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.txt b/README.txt index 57e9ec2..6f15552 100644 --- a/README.txt +++ b/README.txt @@ -1,6 +1,5 @@ +=== TinyIO === -This repository implements a cross-platform (Windows and Linux) API for asynchronous I/O operations. It's backed by io_uring on Linux and I/O completion ports (IOCP) on Windows. It has no dependencies (other than OS stuff and freestanding libc headers) and does no dynamic allocations. +TinyIO is a cross-platform (Windows and Linux) API for asynchronous I/O operations. It's backed by io_uring on Linux and I/O completion ports (IOCP) on Windows. It has no dependencies (other than OS stuff and freestanding libc headers) and does no dynamic allocations. To use it, you need to add io.c and io.h in your source tree and compile them as they were your own files. -It's likely that the io_uring code has some bugs, so be wary! Also bug reports are appreciated :) - -To use it, you need to add io.c and io.h in your source tree and compile them as they were your own files. +<<< WARNING >>> It's likely that the io_uring code has some bugs, so be wary! Also bug reports are appreciated :)