diff --git a/utils/scarb-stable-hash/Cargo.toml b/utils/scarb-stable-hash/Cargo.toml index bfd28812e..1743a630f 100644 --- a/utils/scarb-stable-hash/Cargo.toml +++ b/utils/scarb-stable-hash/Cargo.toml @@ -1,13 +1,13 @@ [package] name = "scarb-stable-hash" version = "1.0.0" -edition.workspace = true +description = "Implementation of a hasher that produces the same values across Scarb releases" +readme = "README.md" authors.workspace = true +edition.workspace = true homepage.workspace = true license.workspace = true -readme.workspace = true repository.workspace = true -publish = false [dependencies] xxhash-rust.workspace = true diff --git a/utils/scarb-stable-hash/README.md b/utils/scarb-stable-hash/README.md new file mode 100644 index 000000000..ad4a8fbfd --- /dev/null +++ b/utils/scarb-stable-hash/README.md @@ -0,0 +1,10 @@ +# Scarb Stable Hash + +This crate provides only one function, implementation of a hasher that produces the same values across Scarb releases +The hasher should be fast and have a low chance of collisions (but is not sufficient for cryptographic purposes). + +## Changelog + +All notable changes to this project are documented on the [GitHub releases] page. + +[github releases]: https://github.com/software-mansion/scarb/releases