diff options
Diffstat (limited to 'third_party/rust/dogear/README.md')
| -rw-r--r-- | third_party/rust/dogear/README.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/third_party/rust/dogear/README.md b/third_party/rust/dogear/README.md new file mode 100644 index 0000000000..f3f939986b --- /dev/null +++ b/third_party/rust/dogear/README.md @@ -0,0 +1,9 @@ +# Dogear + +**Dogear** is a library that implements bookmark tree merging for Firefox Sync. It takes two trees—a valid, consistent local tree, and a possibly inconsistent remote tree—and produces a complete merged tree, with all conflicts and inconsistencies resolved. + +Dogear implements the merge algorithm only; it doesn't handle syncing, storage, or application. It's up to the crate that embeds Dogear to store local and incoming bookmarks, describe how to build a tree from a storage backend, persist the merged tree back to storage, and upload records for changed bookmarks. + +## Requirements + +* Rust 1.31.0 or higher |