Basic documentation for reproducibleBuildsCheck

raboof · Jul 28, 2023 · 2e21ea4 · 2e21ea4
1 parent ae0434c
commit 2e21ea4
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -102,6 +102,18 @@ Checking your certification with the 'official' published
 certification is currently
 [not yet implemented](https://github.com/raboof/sbt-reproducible-builds/issues/69).
 
+### Checking published artifacts
+
+You can check your local artifacts against published ones with
+`sbt clean reproducibleBuildsCheck`. If you want to check
+against a different repository (such as a staging repository),
+you can set the `reproducibleBuildsCheckResolver`:
+
+```
+import net.bzzt.reproduciblebuilds.ReproducibleBuildsPlugin._
+ThisBuild / reproducibleBuildsCheckResolver := "repository-apache-org-staging" at "https://repository.apache.org/content/groups/staging"
+```
+
 ## Drinking our own champagne
 
 From version 0.3 onwards, `sbt-reproducible-builds` should itself be