varia_bsdiff/lib.rs
1//! # Varia: `bsdiff`
2//!
3//! A [`bsdiff`] implementation for [Varia], brought to you by
4//! [@NikolaiVazquez]!
5//!
6//! This library is developed as part of the [Ocean Package Manager][Ocean].
7//!
8//! The binary diffing algorithm by Colin Percival is described in his
9//! ["Naïve Differences of Executable Code"][paper] paper.
10//!
11//! ## Usage
12//!
13//! This crate is available [on crates.io][crate] and can be used by adding the
14//! following to your project's [`Cargo.toml`]:
15//!
16//! ```toml
17//! [dependencies]
18//! varia-bsdiff = "0.0.0"
19//! ```
20//!
21//! and this to your crate root (`main.rs` or `lib.rs`):
22//!
23//! ```rust
24//! extern crate varia_bsdiff;
25//! ```
26//!
27//! This last step is optional in [Rust 2018 edition][2018].
28//!
29//! ## License
30//!
31//! Varia is released under either:
32//!
33//! - [MIT License](https://github.com/oceanpkg/varia/blob/master/LICENSE-MIT)
34//! - [Apache License (Version 2.0)](https://github.com/oceanpkg/varia/blob/master/LICENSE-APACHE)
35//!
36//! at your choosing.
37//!
38//! [`Cargo.toml`]: https://doc.rust-lang.org/cargo/reference/manifest.html
39//! [2018]: https://blog.rust-lang.org/2018/12/06/Rust-1.31-and-rust-2018.html#rust-2018
40//! [crate]: https://crates.io/crates/varia-bsdiff
41//!
42//! [@NikolaiVazquez]: https://twitter.com/NikolaiVazquez
43//! [Ocean]: https://www.oceanpkg.org
44//!
45//! [`bsdiff`]: http://www.daemonology.net/bsdiff
46//! [paper]: http://www.daemonology.net/papers/bsdiff.pdf
47//! [Varia]: https://github.com/oceanpkg/varia
48
49#![deny(missing_docs)]