Document euphoxide crate

This commit is contained in:
Joscha 2025-03-20 08:37:55 +01:00
parent 63e9d9aacf
commit 5672ff3d25

View file

@ -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;