From 5672ff3d25c85d267fba53120b6979286c31d620 Mon Sep 17 00:00:00 2001 From: Joscha Date: Thu, 20 Mar 2025 08:37:55 +0100 Subject: [PATCH] Document euphoxide crate --- euphoxide/src/lib.rs | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/euphoxide/src/lib.rs b/euphoxide/src/lib.rs index 368ad1b..b3b669a 100644 --- a/euphoxide/src/lib.rs +++ b/euphoxide/src/lib.rs @@ -1,3 +1,14 @@ +//! API bindings for [euphoria.leet.nu](https://euphoria.leet.nu/). +//! +//! If you want to write a generic client, see the `euphoxide-client` crate for +//! connection management. If you want to write a bot, the `euphoxide-bot` crate +//! contains additional useful tools. +//! +//! # Useful links +//! +//! - the [euphoria.leet.nu API docs](https://euphoria.leet.nu/heim/api) +//! - [heim](https://github.com/CylonicRaider/heim), the software underlying euphoria + pub mod api; pub mod client; pub mod conn;