Skip to content

Commit

Permalink
Include README.md in lib doc string
Browse files Browse the repository at this point in the history
  • Loading branch information
sandreae committed Aug 31, 2023
1 parent d6ebb2f commit 531a899
Showing 1 changed file with 1 addition and 33 deletions.
34 changes: 1 addition & 33 deletions aquadoggo/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,38 +1,6 @@
// SPDX-License-Identifier: AGPL-3.0-or-later

//! # aquadoggo
//!
//! Configurable node server implementation for the [`p2panda`] network.
//!
//! [`p2panda`]: https://p2panda.org
//!
//! ## Features
//!
//! - Awaits signed operations from clients via GraphQL.
//! - Verifies the consistency, format and signature of operations and rejects invalid ones.
//! - Stores operations of the network in an SQL database of your choice (SQLite, PostgreSQL).
//! - Materializes views on top of the known data.
//! - Answers filterable and paginated data queries via GraphQL.
//! - Discovers other nodes in local network and internet.
//! - Replicates data with other nodes.
//!
//! ## Example
//!
//! Embed the node server in your Rust application or web container like [`Tauri`]:
//!
//! ```rust,no_run
//! # #[tokio::main]
//! # async fn main() {
//! use aquadoggo::{Configuration, Node};
//! use p2panda_rs::identity::KeyPair;
//!
//! let config = Configuration::default();
//! let key_pair = KeyPair::new();
//! let node = Node::start(key_pair, config).await;
//! # }
//! ```
//!
//! [`Tauri`]: https://tauri.studio
#![doc = include_str!("../README.md")]
#![warn(
missing_debug_implementations,
missing_docs,
Expand Down

0 comments on commit 531a899

Please sign in to comment.