Skip to content

document src/lib.rs #62

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
yoshuawuyts merged 3 commits into from
Apr 4, 2019
Merged

document src/lib.rs #62

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
81cfd6c
document-src-lib-rs
FreddieRidell Apr 2, 2019
5ba8e26
changed wording in lib.rs docs
yoshuawuyts Apr 4, 2019
89c89af
not sure how cargo fmt missed this the first time
FreddieRidell Apr 4, 2019
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
11 changes: 11 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
#![forbid(missing_docs)]
#![cfg_attr(test, deny(warnings))]

//! ## Introduction
//! Hypercore is a secure, distributed append-only log. Built for sharing
//! large datasets and streams of real time data as part of the [Dat] project.
//! This is a rust port of [the original node version][dat-node]
//! aiming for interoperability. The primary way to use this crate is through the [Feed] struct.
//!
//!
//! ## Example
//! ```rust
//! extern crate hypercore;
Expand All @@ -20,6 +27,10 @@
//! println!("{:?}", feed.get(0)); // prints "hello"
//! println!("{:?}", feed.get(1)); // prints "world"
//! ```
//!
//! [dat-node]: https://github.com/mafintosh/hypercore
//! [Dat]: https://github.com/datrs
//! [Feed]: crate::feed::Feed

#[macro_use]
extern crate failure;
Expand Down