Firefox Sync's bookmark tree merging algorithm. 📚
Перейти к файлу
Sammy Khamis f83e6db964
Bump Dogear version to v0.5.0 (#72)
* Bump Dogear version to v0.5.0
2022-06-22 14:28:53 -10:00
.github/workflows Adding script to generate/upgrade code coverage (#67) (#69) 2021-07-30 15:51:05 -04:00
docs First draft of the docs. 2019-05-09 16:37:46 -07:00
src Normalize guid errors to allow easier anonymizing/aggregation of data (#71) 2022-06-21 17:51:02 -10:00
.gitignore First draft of the docs. 2019-05-09 16:37:46 -07:00
CODE_OF_CONDUCT.md Fix required CPG text. Closes #32. [skip ci] 2019-03-30 10:23:21 -07:00
Cargo.toml Bump Dogear version to v0.5.0 (#72) 2022-06-22 14:28:53 -10:00
LICENSE Switch to the Apache License. 2018-08-22 17:35:32 -07:00
README.md Bump Dogear version to v0.5.0 (#72) 2022-06-22 14:28:53 -10:00
book.toml First draft of the docs. 2019-05-09 16:37:46 -07:00

README.md

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

Updating this package

Once a new version of Dogear is ready to release. The new version will need to be published to crates.io. Dogear follows the documentation detailed in the Cargo book.

Steps to publish a new verison

  1. Bump the version in the Cargo.toml file
  2. Run cargo publish --dry-run
    • Validate it does what you want it to do
  3. Run cargo publish and follow the steps cargo provides