golgi/src/lib.rs

33 lines
959 B
Rust
Raw Normal View History

2021-12-03 09:37:22 +00:00
#![warn(missing_docs)]
//! # golgi
//!
//! _The Golgi complex (aka. Golgi apparatus or Golgi body) packages proteins into membrane-bound vesicles inside the cell before the vesicles are sent to their destination._
//!
//! -----
//!
//! Golgi is an experimental Scuttlebutt client which uses the [kuska-ssb](https://github.com/Kuska-ssb) libraries and aims to provide a high-level API for interacting with an sbot instance. Development efforts are currently oriented towards [go-sbot](https://github.com/cryptoscope/ssb) interoperability.
//!
//! ## Example Usage
//!
//! ```rust
//! use golgi::GolgiError;
//! use golgi::sbot::Sbot;
//!
//! pub async fn run() -> Result<(), GolgiError> {
//! let mut sbot_client = Sbot::init(None, None).await?;
//!
//! let id = sbot_client.whoami().await?;
//! println!("{}", id);
//!
//! Ok(())
//! }
//! ```
2021-12-02 17:55:31 +00:00
2021-12-02 17:48:16 +00:00
pub mod error;
2021-12-29 15:59:05 +00:00
pub mod messages;
2021-12-29 16:31:53 +00:00
pub mod sbot;
2021-12-29 01:35:46 +00:00
pub mod utils;
2021-12-02 13:12:52 +00:00
2021-12-02 17:48:16 +00:00
pub use crate::error::GolgiError;