aboutsummaryrefslogtreecommitdiff
path: root/src/root.zig
diff options
context:
space:
mode:
authorRobby Zambito <contact@robbyzambito.me>2026-02-01 20:57:58 -0500
committerRobby Zambito <contact@robbyzambito.me>2026-02-01 21:02:39 -0500
commitd1ca448835aed0699b6e5cb8bd03aee0dd05344e (patch)
treea3849cfed74d339ca1e7c400ba492d7fbce6ca5a /src/root.zig
parentf554e7a3bb472c2a8b9e123a7f8ca19a036ba4ac (diff)
parent2c9e648c2c9c487c0239760bff23a70c059f018f (diff)
Release v0.2.00.2.0
Diffstat (limited to 'src/root.zig')
-rw-r--r--src/root.zig31
1 files changed, 24 insertions, 7 deletions
diff --git a/src/root.zig b/src/root.zig
index f7efb7b..2a847fc 100644
--- a/src/root.zig
+++ b/src/root.zig
@@ -1,12 +1,29 @@
-pub const Client = @import("Client.zig");
-pub const Connection = @import("Connection.zig");
+// Copyright 2026 Robby Zambito
+//
+// This file is part of zaprus.
+//
+// Zaprus is free software: you can redistribute it and/or modify it under the
+// terms of the GNU General Public License as published by the Free Software
+// Foundation, either version 3 of the License, or (at your option) any later
+// version.
+//
+// Zaprus is distributed in the hope that it will be useful, but WITHOUT ANY
+// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+// A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License along with
+// Zaprus. If not, see <https://www.gnu.org/licenses/>.
-const msg = @import("message.zig");
+//! 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 PacketType = msg.PacketType;
-pub const MessageTypeError = msg.MessageTypeError;
-pub const MessageParseError = msg.MessageParseError;
-pub const Message = msg.Message;
+pub const Client = @import("Client.zig");
+pub const Connection = @import("Connection.zig");
+pub const Message = @import("message.zig").Message;
test {
@import("std").testing.refAllDecls(@This());