Skip to content

Add Module level docs #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 17, 2023
Merged

Add Module level docs #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
//! Client-side library to interact with Versioned Storage Service (VSS).
//!
//! VSS is an open-source project designed to offer a server-side cloud storage solution specifically
//! tailored for non-custodial Lightning supporting mobile wallets. Its primary objective is to
//! simplify the development process for Lightning wallets by providing a secure means to store
//! and manage the essential state required for Lightning Network (LN) operations.
//!
//! Learn more [here](https://github.com/lightningdevkit/vss-server/blob/main/README.md).

#![deny(rustdoc::broken_intra_doc_links)]
#![deny(rustdoc::private_intra_doc_links)]

use crate::client::VssClient;
use crate::error::VssError;

/// Implements a thin-client ([`VssClient`]) to access a hosted instance of Versioned Storage Service (VSS).
pub mod client;

/// Implements the error type ([`VssError`]) returned on interacting with [`VssClient`]
pub mod error;

/// Contains request/response types generated from the API definition of VSS.
pub mod types;