What is version-sync?

If you've ever released a new version of your software and then realized your README still tells people to install the old version, version-sync is here to help. It's a tool for Rust developers that automatically checks whether references to your project's version number, like in your README or documentation links, match the actual version defined in your project's configuration file. Think of it as a safety net that catches the easy-to-miss details when you're rushing to ship a release. Here's how it works: when you run your project's tests, version-sync scans specific files for version numbers and compares them to the one in your main config. For example, if your README contains a code block showing how to install your library at version 0.1 but you just bumped the real version to 0.2, the test fails and points out exactly where the mismatch is. You can also check that documentation links point to the right versioned page. If you have a code block in your README that intentionally uses an old version number, you can tag it to be skipped during these checks. This tool is designed for Rust developers and library maintainers who publish packages publicly. Imagine you maintain a popular open-source library and you just released version 1.4. You changed the version number in your config, but forgot to update the install instructions in your README. Without this tool, your users might copy-paste outdated instructions and get confused when things don't work. With version-sync, your automated tests catch that mistake before anyone else does. The project is straightforward and focused on doing one job well. It integrates directly into Rust's standard testing workflow, so there's no separate step to remember, if your tests pass, your version references are consistent. The README notes that it can also search files using custom patterns, giving you flexibility beyond just README files.