/ crates / tor-consdiff / README.md
README.md
 1  # tor-consdiff
 2  
 3  Restricted ed diff and patch formats for Tor.
 4  
 5  ## Overview
 6  
 7  This crate is part of
 8  [Arti](https://gitlab.torproject.org/tpo/core/arti/), a project to
 9  implement [Tor](https://www.torproject.org/) in Rust.
10  Tor uses a restricted version of the "ed-style" diff format to
11  record the difference between a pair of consensus documents, so that
12  clients can download only the changes since the last document they
13  have.
14  
15  This crate provides a function to apply one of these diffs to an older
16  consensus document, to get a newer one.
17  
18  TODO: Eventually, when we add relay support, we will need to generate
19  these diffs as well as consume them.
20  
21  License: MIT OR Apache-2.0