From 74893de6f4127cfb12c031865cfb39341e1d48d5 Mon Sep 17 00:00:00 2001
From: Jeff Klukas <jklukas@netflix.com>
Date: Thu, 23 Jan 2025 15:58:22 -0500
Subject: [PATCH] Add README with release instructions (#483)

* Add README with release instructions

* Mention update_remote_tools.sh
---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5e268f0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Bazel Mini Container Image Tools
+
+This repository contains the rust source code for the tools binaries used in
+[`rules_minidock`](https://github.com/bazeltools/rules_minidock).
+
+## Release process
+
+To cut a new release, use the
+[Releases](https://github.com/bazeltools/rules_minidock_tools/tags)
+UI to "Draft a new release" and hit the button to generate release notes.
+A new release will trigger GitHub actions to build the various binaries
+and attach them to the release.
+
+To pull a new tools release into `rules_minidock`, see that repo's
+[`update_remote_tools.sh`](https://github.com/bazeltools/rules_minidock/blob/main/minidock/remote_tools/update_remote_tools.sh).