From 2c9e648c2c9c487c0239760bff23a70c059f018f Mon Sep 17 00:00:00 2001 From: Robby Zambito Date: Sun, 1 Feb 2026 19:35:14 -0500 Subject: Clean API and add docs --- src/root.zig | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) (limited to 'src/root.zig') diff --git a/src/root.zig b/src/root.zig index aa78565..2a847fc 100644 --- a/src/root.zig +++ b/src/root.zig @@ -14,14 +14,16 @@ // You should have received a copy of the GNU General Public License along with // Zaprus. If not, see . +//! The Zaprus library is useful for implementing clients that interact with the [Saprus Protocol](https://gitlab.com/c2-games/red-team/saprus). +//! +//! The main entrypoint into this library is the `Client` type. +//! It can be used to send fire and forget messages, and establish persistent connections. +//! It is up to the consumer of this library to handle non-management message payloads. +//! The library handles management messages automatically (right now, just ping). + pub const Client = @import("Client.zig"); pub const Connection = @import("Connection.zig"); - -const msg = @import("message.zig"); - -pub const MessageTypeError = msg.MessageTypeError; -pub const MessageParseError = msg.MessageParseError; -pub const Message = msg.Message; +pub const Message = @import("message.zig").Message; test { @import("std").testing.refAllDecls(@This()); -- cgit