filthy_rich/lib.rs
1//! This is the API reference page for filthy-rich.
2//!
3//! ## Getting Started
4//!
5//! Please refer to either of these two structs for implementing Rich Presence functionality in your app:
6//!
7//! [`PresenceRunner`] - core runner for rich presence<br>
8//! [`PresenceClient`] - client/messenger instance used for sending activity and closing updates
9//!
10//! ## Looking for Discord's documentation?
11//!
12//! The groundwork of this project has been done using the official [Discord RPC documentation](https://docs.discord.com/developers/topics/rpc)
13//! page. Do note that not all features are/will be implemented as most of them are not fully implemented in Discord itself on a client basis.
14//!
15//! ## Examples
16//!
17//! Library examples can be found in [this directory](https://github.com/hitblast/filthy-rich/tree/master/examples) on GitHub.
18
19mod client;
20mod runner;
21mod socket;
22mod utils;
23
24pub use client::PresenceClient;
25pub use runner::PresenceRunner;
26pub mod types;