doc: Additional clarifications in README

mochalins · Jan 31, 2025 · 2680b20 · 2680b20
1 parent 8f6514b
commit 2680b20
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -2,15 +2,18 @@
 
 ![Linux Port Iteration Result](assets/Linux_Iteration_Demo.png)
 
+Cross-platform serial port library, with convenient poll/read/write interface.
+Kept up to date to work with latest Zig master branch.
+
+The Windows/Linux backends are exercised in certain corporate dev tools, and
+thus are somewhat reliable. MacOS backend is not actively tested.
+
 ## Todo
 
-- [x] Refactor backends to expose public API best suited for OS, then use these
-      APIs in platform-agnostic API implementation
 - [ ] Support flow control status check
 - [ ] Offer both blocking and non-blocking reads/writes
 - [ ] Port descriptions and information
 - [ ] Export C library
-- [ ] Async port interface (dependent on re-introduction of Zig async)
 
 ## Examples
 

diff --git a/src/serialport.zig b/src/serialport.zig
@@ -201,8 +201,8 @@ pub const Config = struct {
         none,
         /// XON-XOFF software flow control is used.
         software,
-        /// Hardware flow control with RTS (RFR) / CTS is used. A.k.a. hardware
-        /// handshaking, pacing.
+        /// Hardware flow control with RTS (RFR) / CTS is used. A.k.a.
+        /// hardware handshaking, pacing.
         hardware,
     };
 };