Skip to content
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

Jump to bottom

Lib-level doc string #263

Merged
merged 2 commits into from
Sep 7, 2022
Merged

Lib-level doc string #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1adb6f0
Write a lib-level doc string
adzialocha Sep 7, 2022
10d43e6
Add entry to CHANGELOG.md
adzialocha Sep 7, 2022
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Fix pagination during replication [#199](https://github.com/p2panda/aquadoggo/pull/256)
- Load `DocumentId` to be able to resolve it in meta field query [#258](https://github.com/p2panda/aquadoggo/pull/258)

### Mushroom Time

- Write a lib-level doc string [#263](https://github.com/p2panda/aquadoggo/pull/263)

## [0.3.0]

Released on 2022-07-01: :package: [`crate`](https://crates.io/crates/aquadoggo/0.3.0)
Expand Down
30 changes: 30 additions & 0 deletions aquadoggo/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,36 @@
// 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};
//!
//! let config = Configuration::default();
//! let node = Node::start(config).await;
//! # }
//! ```
//!
//! [`Tauri`]: https://tauri.studio
#![warn(
missing_copy_implementations,
missing_debug_implementations,
Expand Down