aboutsummaryrefslogtreecommitdiff
path: root/src/root.zig
diff options
context:
space:
mode:
authorRobby Zambito <contact@robbyzambito.me>2026-02-01 19:35:14 -0500
committerRobby Zambito <contact@robbyzambito.me>2026-02-01 21:02:38 -0500
commit2c9e648c2c9c487c0239760bff23a70c059f018f (patch)
tree0167c13947bfab5349dc705aca555658b5d742ff /src/root.zig
parent558f40213b895810a78b2bbcbdbb95e88a301fde (diff)
Clean API and add docs
Diffstat (limited to 'src/root.zig')
-rw-r--r--src/root.zig14
1 files changed, 8 insertions, 6 deletions
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 <https://www.gnu.org/licenses/>.
+//! 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());